sidetree

Documentation

Overview

Package sidetree implements sidetree client

Index

• func SetDebugOutput(out io.Writer)
• type Client
  • func New(opts ...Option) *Client
  • func (c *Client) CreateDID(opts ...create.Option) (*docdid.DocResolution, error)
  • func (c *Client) DeactivateDID(did string, opts ...deactivate.Option) error
  • func (c *Client) RecoverDID(did string, opts ...recovery.Option) error
  • func (c *Client) UpdateDID(did string, opts ...update.Option) error
• type GetEndpointsFunc
• type Option
  • func WithAuthToken(authToken string) Option
  • func WithAuthTokenProvider(p authTokenProvider) Option
  • func WithHTTPClient(httpClient *http.Client) Option
  • func WithSidetreeOperationRequestFnc(fnc func(req []byte, getEndpoints GetEndpointsFunc) ([]byte, error)) Option

Functions

func SetDebugOutput

func SetDebugOutput(out io.Writer)

SetDebugOutput is used to set output of debug logs.

Types

type Client

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

Client sidetree client.

func New

func New(opts ...Option) *Client

New return sidetree client.

func (*Client) CreateDID

func (c *Client) CreateDID(opts ...create.Option) (*docdid.DocResolution, error)

CreateDID create did doc.

func (*Client) DeactivateDID

func (c *Client) DeactivateDID(did string, opts ...deactivate.Option) error

DeactivateDID deactivate did doc.

func (*Client) RecoverDID

func (c *Client) RecoverDID(did string, opts ...recovery.Option) error

RecoverDID recover did doc.

func (*Client) UpdateDID

func (c *Client) UpdateDID(did string, opts ...update.Option) error

UpdateDID update did doc.

type GetEndpointsFunc

type GetEndpointsFunc = func(disableCache bool) ([]string, error)

GetEndpointsFunc retrieves sidetree endpoints.

type Option

type Option func(opts *Client)

Option is a DID client instance option.

func WithAuthToken

func WithAuthToken(authToken string) Option

WithAuthToken add auth token.

func WithAuthTokenProvider

func WithAuthTokenProvider(p authTokenProvider) Option

WithAuthTokenProvider add auth token provider.

func WithHTTPClient

func WithHTTPClient(httpClient *http.Client) Option

WithHTTPClient option is for custom http client.

func WithSidetreeOperationRequestFnc

func WithSidetreeOperationRequestFnc(fnc func(req []byte, getEndpoints GetEndpointsFunc) ([]byte, error)) Option

WithSidetreeOperationRequestFnc overrides default sidetree operation request.