sidetreehandler

Documentation

Index

• type Config
• type Version
  • func NewVersionHandler(channelID string, cfg Config, pc protocol.Client) *Version
  • func (h *Version) Handler() common.HTTPRequestHandler
  • func (h *Version) Method() string
  • func (h *Version) Path() string

Types

type Config

type Config struct {
	Authorization authhandler.Config

	// Version contains the version of the Sidetree endpoint
	Version string
	// DocType specifies the document type (DID or File index)
	DocType common.DocumentType
	// Namespace is the namespace prefix used in the ID of the document
	Namespace string
	// Aliases is the namespace aliases that can be used in the ID of the document
	Aliases []string
	// BasePath is the base context path of the REST endpoint
	BasePath string
	// DocumentCacheSize is the maximum number of documents to hold in the cache. If 0 then the default cache size is used.
	DocumentCacheSize uint
	// DocumentExpiry returns the expiration time of a cached document. If zero then the document never expires.
	DocumentExpiry time.Duration
}

Config holds Sidetree endpoint handler config

type Version

type Version struct {
	Config
	// contains filtered or unexported fields
}

Version retrieves the current version and version parameters or the version and version parameters for a given transaction time

func NewVersionHandler

func NewVersionHandler(channelID string, cfg Config, pc protocol.Client) *Version

NewVersionHandler returns a new Version handler

func (*Version) Handler

func (h *Version) Handler() common.HTTPRequestHandler

Handler returns the request handler

func (*Version) Method

func (h *Version) Method() string

Method returns the HTTP method

func (*Version) Path

func (h *Version) Path() string

Path returns the context path