didclient

package

v0.1.7 Latest Latest Go to latest Published: Sep 17, 2021 License: Apache-2.0 Imports: 23 Imported by: 2

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/trustbloc/agent-sdk

Links

Open Source Insights

Documentation ¶

Overview ¶

Package didclient provides did commands.

Index ¶

Constants
type Command
- func New(domain, didAnchorOrigin, token string, p Provider) (*Command, error)
type CreateDIDResponse
type CreateOrbDIDRequest
type CreatePeerDIDRequest
type Provider
type PublicKey

Constants ¶

View Source

const (
	// CommandName package command name.
	CommandName = "didclient"
	// CreateOrbDIDCommandMethod command method.
	CreateOrbDIDCommandMethod = "CreateOrbDID"
	// CreatePeerDIDCommandMethod command method.
	CreatePeerDIDCommandMethod = "CreatePeerDID"

	// BLS12381G2KeyType BLS12381G2 key type.
	BLS12381G2KeyType = "bls12381g2"
)

View Source

const (
	// InvalidRequestErrorCode is typically a code for validation errors.
	InvalidRequestErrorCode = command.Code(iota + command.DIDClient)

	// CreateDIDErrorCode is typically a code for create did errors.
	CreateDIDErrorCode
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Command ¶

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

Command is controller command for DID Exchange.

func New ¶

func New(domain, didAnchorOrigin, token string, p Provider) (*Command, error)

New returns new DID Exchange controller command instance.

func (*Command) CreateOrbDID ¶ added in v0.1.7

func (c *Command) CreateOrbDID(rw io.Writer, req io.Reader) command.Error

CreateOrbDID creates a new orb DID.

func (*Command) CreatePeerDID ¶

func (c *Command) CreatePeerDID(rw io.Writer, req io.Reader) command.Error

CreatePeerDID creates a new peer DID.

func (*Command) GetHandlers ¶

func (c *Command) GetHandlers() []command.Handler

GetHandlers returns list of all commands supported by this controller command.

type CreateDIDResponse ¶

type CreateDIDResponse struct {
	DID json.RawMessage
}

CreateDIDResponse contains the newly-create DID doc.

type CreateOrbDIDRequest ¶ added in v0.1.7

type CreateOrbDIDRequest struct {
	PublicKeys []PublicKey `json:"publicKeys,omitempty"`
}

CreateOrbDIDRequest model

This is used for creating orb DID.

type CreatePeerDIDRequest ¶

type CreatePeerDIDRequest struct {
	RouterConnectionID string `json:"routerConnectionID,omitempty"`
}

CreatePeerDIDRequest model

This is used for creating peer DID.

type Provider ¶

type Provider interface {
	VDRegistry() vdr.Registry
	Service(id string) (interface{}, error)
	KMS() kms.KeyManager
}

Provider describes dependencies for the client.

type PublicKey ¶

type PublicKey struct {
	ID       string   `json:"id,omitempty"`
	Type     string   `json:"type,omitempty"`
	Encoding string   `json:"encoding,omitempty"`
	KeyType  string   `json:"keyType,omitempty"`
	Purposes []string `json:"purposes,omitempty"`
	Recovery bool     `json:"recovery,omitempty"`
	Update   bool     `json:"update,omitempty"`
	Value    string   `json:"value,omitempty"`
}

PublicKey public key.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL