key

Documentation

Index

• Constants
• func PubKeyToID(pubKey crypto.PubKey) string
• type NodeKey
  • func GenerateNodeKey() (*NodeKey, error)
  • func LoadNodeKey(dirPath string) (*NodeKey, error)
  • func LoadOrGenNodeKey(dirPath string) (*NodeKey, error)
  • func (nodeKey *NodeKey) ID() string
  • func (nodeKey *NodeKey) MarshalJSON() ([]byte, error)
  • func (nodeKey *NodeKey) SaveAs(dirPath string) error
  • func (nodeKey *NodeKey) UnmarshalJSON(data []byte) error

Constants

const (
	NodeKeyFileName = "node_key.json"
)

Functions

func PubKeyToID

func PubKeyToID(pubKey crypto.PubKey) string

PubKeyToID returns the ID corresponding to the given PubKey. It's the hex-encoding of the pubKey.Address().

Types

type NodeKey

type NodeKey struct {
	PrivKey crypto.PrivKey // our priv key
	PubKey  crypto.PubKey  // our pub key
}

NodeKey is the persistent peer key. It contains the nodes private key for authentication.

func GenerateNodeKey

func GenerateNodeKey() (*NodeKey, error)

GenerateNodeKey generates a new NodeKey

func LoadNodeKey

func LoadNodeKey(dirPath string) (*NodeKey, error)

LoadNodeKey loads NodeKey located in dirPath/node_key.json.

func LoadOrGenNodeKey

func LoadOrGenNodeKey(dirPath string) (*NodeKey, error)

LoadOrGenNodeKey attempts to load the NodeKey from the given directory path. If the file node_key.json does not exist in that directory, it generates and saves a new NodeKey there.

func (*NodeKey) ID

func (nodeKey *NodeKey) ID() string

ID returns the peer's canonical ID - the hash of its public key.

func (*NodeKey) MarshalJSON

func (nodeKey *NodeKey) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface.

func (*NodeKey) SaveAs

func (nodeKey *NodeKey) SaveAs(dirPath string) error

SaveAs persists the NodeKey to filePath.

func (*NodeKey) UnmarshalJSON

func (nodeKey *NodeKey) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface.