api

Documentation

Index

• func ParseLongForm(uri string) (SuffixData, Delta, error)
• type API
  • func New(opts ...Options) (*API, error)
  • func (a *API) Submit(i interface{}) ([]byte, error)
• type Create
  • func CreateOperation(suffixData SuffixData, delta Delta) Create
  • func (c Create) EncodedSuffixData() (string, error)
  • func (c Create) LongFormURI(method string) (string, error)
  • func (c Create) ShortFormURI(method string) (string, error)
• type Deactivate
  • func DeactivateOperation(suffix, reveal, signature string) Deactivate
• type Delta
• type Operation
• type Options
  • func WithChallenge(endpoint string) Options
  • func WithEndpoint(endpoint string) Options
• type Recover
  • func RecoverOperation(suffix, reveal, signature string, delta Delta) Recover
• type SuffixData
  • func (s SuffixData) URI() (string, error)
• type Update
  • func UpdateOperation(suffix, reveal, signature string, delta Delta) Update
• type UpdateOp

Functions

func ParseLongForm

func ParseLongForm(uri string) (SuffixData, Delta, error)

Types

type API

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

func New

func New(opts ...Options) (*API, error)

func (*API) Submit

func (a *API) Submit(i interface{}) ([]byte, error)

type Create

type Create struct {
	Operation
	SuffixData SuffixData `json:"suffixData"`
	Delta      Delta      `json:"delta"`
}

func CreateOperation

func CreateOperation(suffixData SuffixData, delta Delta) Create

func (Create) EncodedSuffixData

func (c Create) EncodedSuffixData() (string, error)

func (Create) LongFormURI

func (c Create) LongFormURI(method string) (string, error)

func (Create) ShortFormURI

func (c Create) ShortFormURI(method string) (string, error)

type Deactivate

type Deactivate struct {
	Operation
	UpdateOp
}

func DeactivateOperation

func DeactivateOperation(suffix, reveal, signature string) Deactivate

type Delta

type Delta struct {
	Patches          []map[string]interface{} `json:"patches"`
	UpdateCommitment string                   `json:"updateCommitment"`
}

type Operation

type Operation struct {
	Type string `json:"type"`
}

type Options

type Options func(a *API) error

func WithChallenge

func WithChallenge(endpoint string) Options

func WithEndpoint

func WithEndpoint(endpoint string) Options

type Recover

type Recover Update

func RecoverOperation

func RecoverOperation(suffix, reveal, signature string, delta Delta) Recover

type SuffixData

type SuffixData struct {
	Type               string `json:"type,omitempty"`
	DeltaHash          string `json:"deltaHash"`
	RecoveryCommitment string `json:"recoveryCommitment"`
	AnchorOrigin       string `json:"anchorOrigin,omitempty"`
}

func (SuffixData) URI

func (s SuffixData) URI() (string, error)

type Update

type Update struct {
	Operation
	UpdateOp
	Delta Delta `json:"delta"`
}

func UpdateOperation

func UpdateOperation(suffix, reveal, signature string, delta Delta) Update

type UpdateOp

type UpdateOp struct {
	DIDSuffix   string `json:"didSuffix"`
	RevealValue string `json:"revealValue"`
	SignedData  string `json:"signedData"`
}