glitterboot

package module

v0.1.2 Latest Latest Go to latest Published: Apr 20, 2022 License: Apache-2.0 Imports: 24 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/glitternetwork/glitter-boot

Links

Open Source Insights

README ¶

glitter-boot

Glitter bootstrap tool

Install

go install github.com/glitternetwork/glitter-boot/cmd/glitter-boot@v0.1.1

Commands

# ./glitter-boot 
Glitter bootstrap tool

Usage:
  glitter-boot [command]

Available Commands:
  completion     Generate the autocompletion script for the specified shell
  help           Help about any command
  init           init node
  show-node-info show node info
  start          start [target: `fullnode` or `validator`]
  stop           stop glitter and tendermint services

Flags:
  -h, --help   help for glitter-boot

Use "glitter-boot [command] --help" for more information about a command.

init

Download glitter binary and init services

Before executing this command, you need to create the glitter user and user group

Argumets

Name	Description	Required	Default
`seeds`	seed nodes for connect to testnet	true	""
`moniker`	moniker for node	true	""
`indexer`	fullnode indexMode 'es' or 'kv'	false	"kv"
`glitter_bin_url`	glitter download url	false	"https://storage.googleapis.com/glitterprotocol.appspot.com/tendermint"
`tendermint_bin_url`	tendermint download url	false	"https://storage.googleapis.com/glitterprotocol.appspot.com/glitter-v0.1.0/glitter"

start

Start as fullnode or validator

stop

Stop all services

show-node-info

Show node info

Example

NodeID:         3d187f86dde4a5f5f412cb282e52a59838d68bad
Moniker:        node3

PubKey:         xxxy5074AbhOITINxFBqp/cQ4rZVEwen3JlZnRkrcII=
Address:        XXXX62A7A195983BABE17299EC375A486B25E1C5

Tendermint Status: active

Glitter    Status: active


PrivateKeyFile: ~/.glitter-boot/priv_validator_key.json
GlitterBootDir: ~/.glitter-boot

Options

  -h, --help   help for glitter-boot

Documentation ¶

Index ¶

func NewTMClient(tendermintAddr string) (*thttp.HTTP, error)
func NodeOperate(ctx context.Context, args NodeOpsArgs)
type CopyFileDesc
type NodeAddr
- func (n *NodeAddr) String() string
type NodeOperateType
type NodeOpsArgs
type TendermintClient

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func NewTMClient ¶

func NewTMClient(tendermintAddr string) (*thttp.HTTP, error)

func NodeOperate ¶ added in v0.1.1

func NodeOperate(ctx context.Context, args NodeOpsArgs)

Types ¶

type CopyFileDesc ¶

type CopyFileDesc struct {
	Src  string
	Dest string
}

type NodeAddr ¶

type NodeAddr struct {
	Address string
	Host    string
	Port    string
}

func (*NodeAddr) String ¶

func (n *NodeAddr) String() string

type NodeOperateType ¶ added in v0.1.1

type NodeOperateType int

const (
	OpsInit NodeOperateType = 0 + iota
	OpsStartFullNode
	OpsStartValidator
	OpsStopNode
	OpsShowNodeInfo
)

type NodeOpsArgs ¶ added in v0.1.1

type NodeOpsArgs struct {
	Type                NodeOperateType
	Seeds               string
	Moniker             string
	IndexMode           string
	GlitterBinaryURL    string
	TendermintBinaryURL string
}

type TendermintClient ¶

type TendermintClient = thttp.HTTP

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd
glitter-boot
glitter-boot/cmd

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