sidetree

package module

v1.0.0-rc4 Latest Latest Go to latest Published: Nov 11, 2022 License: Apache-2.0 Imports: 20 Imported by: 5

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package sidetree implements sidetree client

This section is empty.

This section is empty.

This section is empty.

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

Client sidetree client.

func New(opts ...Option) *Client

New return sidetree client.

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

CreateDID create did doc.

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

DeactivateDID deactivate did doc.

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

RecoverDID recover did doc.

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

UpdateDID update did doc.

type Option func(opts *Client)

Option is a DID client instance option.

func WithAuthToken(authToken string) Option

WithAuthToken add auth token.

func WithAuthTokenProvider(p authTokenProvider) Option

WithAuthTokenProvider add auth token provider.

func WithHTTPClient(httpClient *http.Client) Option

WithHTTPClient option is for custom http client.

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

WithSidetreeOperationRequestFnc overrides default sidetree operation request.

Path	Synopsis
api Package api include interface	Package api include interface
doc Package doc implements sidetree document	Package doc implements sidetree document
option
create Package create implements sidetree create did option	Package create implements sidetree create did option
deactivate Package deactivate implements sidetree deactivate did option	Package deactivate implements sidetree deactivate did option
recovery Package recovery implements sidetree recovery did option	Package recovery implements sidetree recovery did option
update Package update implements sidetree update did option	Package update implements sidetree update did option