ockam.go

package ockam

import (
	"encoding/json"

	"github.com/ockam-network/did"
)

// Block represents a block in the Ockam Blockchain
type Block interface {
	Height() string
	Hash() string
}

// Chain represents a chain of blocks that is maintained by a network of nodes
type Chain interface {
	ID() string
	Sync() error
	LatestBlock() Block
	Register(Entity) (Claim, error)
	Submit(Claim) error
	FetchClaim(string) ([]byte, Claim, error)
	FetchEntity(string) ([]byte, Entity, error)
}

// Node represents a node connected to a network of other peer nodes
type Node interface {
	Chain
	Peers() []Node
	Chain() Chain
}

// NodeDiscoverer provides the means to discover other nodes on in a network
type NodeDiscoverer interface {
	Discover() ([]Node, error)
}

// PublicKey is
type PublicKey interface {
	Label() string
	SetLabel(string)

	Owner() Entity
	SetOwner(Entity)

	Type() string
	Encoding() string
	Value() string

	DID() (*did.DID, error)
}

// Signature is
// https://w3c-dvcg.github.io/ld-signatures/#linked-data-signature-overview
type Signature interface {
	// Type
	// https://w3c-ccg.github.io/ld-cryptosuite-registry/#ed25519signature2018
	Type() string
	Creator() string
	Created() string
	Domain() string

	// Nonce
	// https://web-payments.org/vocabs/security#nonce
	Nonce() string

	// SignatureValue
	// https://web-payments.org/vocabs/security#signatureValue
	SignatureValue() []byte

	SignedValue() []byte
}

// Claim is
type Claim interface {
	ID() string
	Nonce() string

	Type() string
	SetType(string)

	Issuer() Entity
	SetIssuer(Entity)

	Subject() Entity
	SetSubject(Entity)

	Data() map[string]interface{}
	SetData(map[string]interface{})

	Signatures() []Signature
	AddSignature(Signature)

	json.Marshaler
}

// Entity represents and Ockam entity
type Entity interface {
	ID() *did.DID
	PublicKeys() []PublicKey
	Signers() []Signer
	Attributes() map[string]interface{}
}

// Signer is
type Signer interface {
	PublicKey() PublicKey
	Sign(Claim) error
	SignatureType() string
}

// Fields is
type Fields map[string]interface{}

// Logger is an interface for Logging.
type Logger interface {
	Error(format string, v ...interface{})
	Warn(format string, v ...interface{})
	Notice(format string, v ...interface{})
	Info(format string, v ...interface{})
	Debug(format string, v ...interface{})
	WithFields(fields Fields) Logger
}

type Store interface {
	Put(key, value interface{}) error
	Get(key interface{}) (value interface{}, err error)
	Delete(key interface{}) error
}

type CommitStore interface {
	Store
	GetLastTrusted() (interface{}, error)
	StoreLastTrusted(lastTrusted interface{}) error
}

// Cryptographer is
type Cryptographer interface {
	GenerateKeyPair() (publicKey []byte, secretKey []byte, err error)

	AnonymousEncrypt(unencrypted []byte, recipientPublicKey []byte) (encrypted []byte, err error)
	AnonymousDecrypt(encrypted []byte, recipientSecretKey []byte) (unencrypted []byte, err error)

	Sign(message []byte, secretKey []byte) (signed []byte, err error)
	VerifySignature(signed []byte, signerPublicKey []byte) (ok bool, message []byte, err error)

	AuthenticatedEncrypt(unencrypted []byte, senderSecretKey []byte, recipientPublicKey []byte, nonce []byte) (
		encrypted []byte, err error)
	AuthenticatedDecrypt(encrypted []byte, recipientSecretKey []byte, senderPublicKey []byte, nonce []byte) (
		unencrypted []byte, err error)
}

// Version returns the current version of Ockam
func Version() string {
	version := "0.3.2"
	return version
}