repo

Documentation

Index

• Constants
• func AddrToPeerInfo(multiAddr string) (*peer.AddrInfo, error)
• func AddrsToPeerInfo(multiAddrs []string) ([]peer.AddrInfo, error)
• func GetAPI(repoRoot string) (string, error)
• func GetKeyPath(repoRoot string) string
• func GetPidFromPrivFile(privPath string) (string, error)
• func GetStoragePath(repoRoot string, subPath ...string) string
• func Initialize(repoRoot string) error
• func Initialized(repoRoot string) bool
• func MultiaddrToPeerID(multiAddr string) (string, error)
• func PathRoot() (string, error)
• func PathRootWithDefault(path string) (string, error)
• func ReadConfig(path, configType string, config interface{}) error
• type Cert
• type Certs
• type Config
  • func DefaultConfig() (*Config, error)
  • func UnmarshalConfig(repoRoot string) (*Config, error)
  • func (c *Config) Bytes() ([]byte, error)
• type Executor
• type Gateway
• type Genesis
• type Key
  • func LoadKey(path string) (*Key, error)
• type Log
• type LogModule
• type Monitor
• type NetworkConfig
  • func (p NetworkConfig) Len() int
  • func (p NetworkConfig) Less(i, j int) bool
  • func (p NetworkConfig) Swap(i, j int)
• type NetworkNode
• type Order
• type PProf
• type Port
• type ReadinNetworkConfig
• type Repo
  • func Load(repoRoot string) (*Repo, error)
• type Security
• type Txpool

Constants

const (

	// key name
	KeyName = "key.json"
	// API name
	APIName = "api"
)

Functions

func AddrToPeerInfo

func AddrToPeerInfo(multiAddr string) (*peer.AddrInfo, error)

AddrToPeerInfo transfer addr to PeerInfo addr example: "/ip4/104.236.76.40/tcp/4001/ipfs/QmSoLV4Bbm51jM9C4gDYZQ9Cy3U6aXMJDAbzgu2fzaDs64"

func AddrsToPeerInfo

func AddrsToPeerInfo(multiAddrs []string) ([]peer.AddrInfo, error)

AddrsToPeerInfo transfer addrs to PeerInfo

func GetAPI

func GetAPI(repoRoot string) (string, error)

func GetKeyPath

func GetKeyPath(repoRoot string) string

func GetPidFromPrivFile

func GetPidFromPrivFile(privPath string) (string, error)

GetPidFromPrivFile gets pid from libp2p node priv file

func GetStoragePath

func GetStoragePath(repoRoot string, subPath ...string) string

func Initialize

func Initialize(repoRoot string) error

func Initialized

func Initialized(repoRoot string) bool

func MultiaddrToPeerID

func MultiaddrToPeerID(multiAddr string) (string, error)

MultiaddrToPeerID .

func PathRoot

func PathRoot() (string, error)

func PathRootWithDefault

func PathRootWithDefault(path string) (string, error)

func ReadConfig

func ReadConfig(path, configType string, config interface{}) error

Types

type Cert

type Cert struct {
	Verify bool `toml:"verify" json:"verify"`
}

type Certs

type Certs struct {
	NodeCertData   []byte
	AgencyCertData []byte
	CACertData     []byte
	NodeCert       *x509.Certificate
	AgencyCert     *x509.Certificate
	CACert         *x509.Certificate
}

type Config

type Config struct {
	RepoRoot string `json:"repo_root"`
	Title    string `json:"title"`
	Solo     bool   `json:"solo"`
	Port     `json:"port"`
	PProf    `json:"pprof"`
	Monitor  `json:"monitor"`
	Gateway  `json:"gateway"`
	Log      `json:"log"`
	Cert     `json:"cert"`
	Txpool   `json:"txpool"`
	Order    `json:"order"`
	Executor `json:"executor"`
	Security Security `toml:"security" json:"security"`
}

func DefaultConfig

func DefaultConfig() (*Config, error)

func UnmarshalConfig

func UnmarshalConfig(repoRoot string) (*Config, error)

func (*Config) Bytes

func (c *Config) Bytes() ([]byte, error)

type Executor

type Executor struct {
	Type string `toml:"type" json:"type"`
}

type Gateway

type Gateway struct {
	AllowedOrigins []string `mapstructure:"allowed_origins"`
}

type Genesis

type Genesis struct {
	Addresses []string `json:"addresses" toml:"addresses"`
}

type Key

type Key struct {
	Address       string             `json:"address"`
	PrivKey       crypto2.PrivateKey `json:"priv_key"`
	Libp2pPrivKey crypto.PrivKey
}

func LoadKey

func LoadKey(path string) (*Key, error)

type Log

type Log struct {
	Level        string    `toml:"level" json:"level"`
	Dir          string    `toml:"dir" json:"dir"`
	Filename     string    `toml:"filename" json:"filename"`
	ReportCaller bool      `mapstructure:"report_caller" json:"report_caller"`
	Module       LogModule `toml:"module" json:"module"`
}

type LogModule

type LogModule struct {
	P2P       string `toml:"p2p" json:"p2p"`
	Consensus string `toml:"consensus" json:"consensus"`
	Executor  string `toml:"executor" json:"executor"`
	Router    string `toml:"router" json:"router"`
	API       string `toml:"api" json:"api"`
	CoreAPI   string `mapstructure:"coreapi" toml:"coreapi" json:"coreapi"`
	Storage   string `toml:"storage" json:"storage"`
}

type Monitor

type Monitor struct {
	Enable bool
}

type NetworkConfig

type NetworkConfig struct {
	ID         uint64
	N          uint64
	LocalAddr  string
	Nodes      []*NetworkNode
	OtherNodes map[uint64]*peer.AddrInfo
}

NetworkConfig . @param OtherNodes to fit original code @param OthersNodes for new network config

func (NetworkConfig) Len

func (p NetworkConfig) Len() int

Len returns length of the struct to be sorted

func (NetworkConfig) Less

func (p NetworkConfig) Less(i, j int) bool

Less compares two iterms ascending(ASC)

func (NetworkConfig) Swap

func (p NetworkConfig) Swap(i, j int)

Swap swaps iterms

type NetworkNode

type NetworkNode struct {
	ID    uint64
	Addr  string // the optimal address of a node
	Addrs []string
}

NetworkNode is the struct to describe network conf of a node @param ID is the id of the node, it is origined by sorting. @param Addrs is the address array of the node. @param Addr is the default used address the node.

type Order

type Order struct {
	Plugin string `toml:"plugin" json:"plugin"`
}

type PProf

type PProf struct {
	Enable   bool          `toml:"enbale" json:"enable"`
	PType    string        `toml:"ptype" json:"ptype"`
	Mode     string        `toml:"mode" json:"mode"`
	Duration time.Duration `toml:"duration" json:"duration"`
}

type Port

type Port struct {
	Grpc    int64 `toml:"grpc" json:"grpc"`
	Gateway int64 `toml:"gateway" json:"gateway"`
	PProf   int64 `toml:"pprof" json:"pprof"`
	Monitor int64 `toml:"monitor" json:"monitor"`
}

type ReadinNetworkConfig

type ReadinNetworkConfig struct {
	Addrs [][]string
}

ReadinNetworkConfig is used for read in toml file

type Repo

type Repo struct {
	Config        *Config
	NetworkConfig *NetworkConfig
	Genesis       *Genesis
	Key           *Key
	Certs         *Certs
}

func Load

func Load(repoRoot string) (*Repo, error)

type Security

type Security struct {
	EnableTLS     bool   `mapstructure:"enable_tls"`
	PemFilePath   string `mapstructure:"pem_file_path" json:"pem_file_path"`
	ServerKeyPath string `mapstructure:"server_key_path" json:"server_key_path"`
}

Security are files used to setup connection with tls

type Txpool

type Txpool struct {
	BatchSize    int           `mapstructure:"batch_size" json:"batch_size"`
	BatchTimeout time.Duration `mapstructure:"batch_timeout" json:"batch_timeout"`
}