sd

Documentation

Index

• Constants
• Variables
• type GetEntriesParams
• type GetEntryParams
• type GetRecordsParams
• type GetTipParams
• type RecordDirectory
  • func MakeRecordDirectory(settings *RecordDirectorySettings, definitions *hyper.Definitions) (*RecordDirectory, error)
  • func (f *RecordDirectory) AllEntries() ([]*hyper.DirectoryEntry, error)
  • func (f *RecordDirectory) Append(records []*hyper.SignedChangeRecord) error
  • func (f *RecordDirectory) Entries(*hyper.DirectoryQuery) ([]*hyper.DirectoryEntry, error)
  • func (f *RecordDirectory) Entry(name string) (*hyper.DirectoryEntry, error)
  • func (f *RecordDirectory) Records(after string) ([]*hyper.SignedChangeRecord, error)
  • func (f *RecordDirectory) Tip() (*hyper.SignedChangeRecord, error)
  • func (f *RecordDirectory) Update() error
• type RecordDirectorySettings
• type Server
  • func MakeServer(settings *Settings) (*Server, error)
  • func (s *Server) Start() error
  • func (s *Server) Stop() error
• type Settings
• type SubmitChangeRecordsParams

Constants

const (
	SignedChangeRecordEntry uint8 = 1
)

Variables

var GetEntriesForm = forms.Form{
	Fields: []forms.Field{},
}

var GetEntryForm = forms.Form{
	Fields: []forms.Field{
		{
			Name: "name",
			Validators: []forms.Validator{
				forms.IsString{},
			},
		},
	},
}

var GetRecordsForm = forms.Form{
	Fields: []forms.Field{
		{
			Name: "after",
			Validators: []forms.Validator{
				forms.IsOptional{Default: ""},
				forms.IsString{},
				forms.MatchesRegex{
					Regexp: regexp.MustCompile(`^([a-f0-9]{64}|)$`),
				},
			},
		},
	},
}

var GetTipForm = forms.Form{
	Fields: []forms.Field{},
}

var RecordDirectorySettingsForm = forms.Form{
	Fields: []forms.Field{
		{
			Name: "datastore",
			Validators: []forms.Validator{
				forms.IsStringMap{
					Form: &hyperForms.DatastoreForm,
				},
			},
		},
		{
			Name: "metrics",
			Validators: []forms.Validator{
				forms.IsOptional{},
				forms.IsStringMap{
					Form: &hyperForms.MetricsSettingsForm,
				},
			},
		},
		{
			Name: "ca_certificate_files",
			Validators: []forms.Validator{
				forms.IsList{
					Validators: []forms.Validator{
						forms.IsString{},
					},
				},
			},
		},
		{
			Name: "ca_intermediate_certificate_files",
			Validators: []forms.Validator{
				forms.IsOptional{},
				forms.IsList{
					Validators: []forms.Validator{
						forms.IsString{},
					},
				},
			},
		},
	},
}

var SettingsForm = forms.Form{
	Fields: []forms.Field{
		{
			Name: "directory",
			Validators: []forms.Validator{
				forms.IsStringMap{
					Form: &RecordDirectorySettingsForm,
				},
			},
		},
		{
			Name: "jsonrpc_server",
			Validators: []forms.Validator{
				forms.IsStringMap{
					Form: &jsonrpc.JSONRPCServerSettingsForm,
				},
			},
		},
	},
}

var SubmitChangeRecordsForm = forms.Form{
	Fields: []forms.Field{
		{
			Name: "records",
			Validators: []forms.Validator{
				forms.IsList{
					Validators: []forms.Validator{
						forms.IsStringMap{
							Form: &hyperForms.SignedChangeRecordForm,
						},
					},
				},
			},
		},
	},
}

Types

type GetEntriesParams

type GetEntriesParams struct {
}

type GetEntryParams

type GetEntryParams struct {
	Name string `json:"name"`
}

type GetRecordsParams

type GetRecordsParams struct {
	After string `json:"after"`
}

type GetTipParams

type GetTipParams struct {
}

type RecordDirectory

type RecordDirectory struct {
	// contains filtered or unexported fields
}

func MakeRecordDirectory

func MakeRecordDirectory(settings *RecordDirectorySettings, definitions *hyper.Definitions) (*RecordDirectory, error)

func (*RecordDirectory) AllEntries

func (f *RecordDirectory) AllEntries() ([]*hyper.DirectoryEntry, error)

func (*RecordDirectory) Append

func (f *RecordDirectory) Append(records []*hyper.SignedChangeRecord) error

Appends a series of records

func (*RecordDirectory) Entries

func (f *RecordDirectory) Entries(*hyper.DirectoryQuery) ([]*hyper.DirectoryEntry, error)

func (*RecordDirectory) Entry

func (f *RecordDirectory) Entry(name string) (*hyper.DirectoryEntry, error)

func (*RecordDirectory) Records

func (f *RecordDirectory) Records(after string) ([]*hyper.SignedChangeRecord, error)

Returns all records after a given hash

func (*RecordDirectory) Tip

func (f *RecordDirectory) Tip() (*hyper.SignedChangeRecord, error)

Returns the latest record

func (*RecordDirectory) Update

func (f *RecordDirectory) Update() error

type RecordDirectorySettings

type RecordDirectorySettings struct {
	Datastore                      *hyper.DatastoreSettings `json:"datastore"`
	CACertificateFiles             []string                 `json:"ca_certificate_files"`
	CAIntermediateCertificateFiles []string                 `json:"ca_intermediate_certificate_files"`
}

type Server

type Server struct {
	// contains filtered or unexported fields
}

func MakeServer

func MakeServer(settings *Settings) (*Server, error)

func (*Server) Start

func (s *Server) Start() error

func (*Server) Stop

func (s *Server) Stop() error

type Settings

type Settings struct {
	Definitions   *hyper.Definitions             `json:"definitions"`
	Metrics       *hyper.MetricsSettings         `json:"metrics"`
	JSONRPCServer *jsonrpc.JSONRPCServerSettings `json:"jsonrpc_server`
	Directory     *RecordDirectorySettings       `json:"directory"`
}

type SubmitChangeRecordsParams

type SubmitChangeRecordsParams struct {
	Records []*hyper.SignedChangeRecord `json:"records"`
}