services

Documentation

Index

• Variables
• type DIDResolutionProver
• type DIDResolutionProverRegistry
  • func NewDIDResolutionProverRegistry() *DIDResolutionProverRegistry
  • func (ch *DIDResolutionProverRegistry) Add(proofType verifiable.ProofType, prover DIDResolutionProver)
  • func (ch *DIDResolutionProverRegistry) Append(proofType verifiable.ProofType, prover DIDResolutionProver) error
  • func (ch *DIDResolutionProverRegistry) GetDIDResolutionProverByProofType(proofType verifiable.ProofType) (DIDResolutionProver, error)
• type DidDocumentOption
  • func WithProvers(provers *DIDResolutionProverRegistry) DidDocumentOption
• type DidDocumentServices
  • func NewDidDocumentServices(resolvers *ResolverRegistry, registry *ens.Registry, opts ...DidDocumentOption) *DidDocumentServices
  • func (d *DidDocumentServices) GetDidDocument(ctx context.Context, did string, opts *ResolverOpts) (*document.DidResolution, error)
  • func (d *DidDocumentServices) GetGist(ctx context.Context, chain, network string, opts *ResolverOpts) (*verifiable.GistInfo, error)
  • func (d *DidDocumentServices) ResolveDNSDomain(ctx context.Context, domain string) (*document.DidResolution, error)
  • func (d *DidDocumentServices) ResolveENSDomain(ctx context.Context, domain string) (*document.DidResolution, error)
• type GistInfo
  • func (gi *GistInfo) ToDidRepresentation() (*verifiable.GistInfo, error)
• type IdentityState
• type Resolver
• type ResolverOpts
• type ResolverRegistry
  • func NewChainResolvers() *ResolverRegistry
  • func (ch *ResolverRegistry) Add(prefix string, resolver Resolver)
  • func (ch *ResolverRegistry) Append(prefix string, resolver Resolver) error
  • func (ch *ResolverRegistry) GetResolverByNetwork(chain, networkID string) (Resolver, error)
• type StateInfo
  • func (si *StateInfo) ToDidRepresentation() (*verifiable.StateInfo, error)
• type StateType

Variables

var (
	ErrNetworkIsNotSupported   = errors.New("network is not supported")
	ErrProofTypeIsNotSupported = errors.New("proof is not supported")

	ErrResolverAlreadyExists = errors.New("resolver already exists")

	ErrNotFound = errors.New("not found")
)

Types

type DIDResolutionProver

type DIDResolutionProver interface {
	Prove(did w3c.DID, info IdentityState, dataType StateType) (document.DidResolutionProof, error)
}

type DIDResolutionProverRegistry

type DIDResolutionProverRegistry map[verifiable.ProofType]DIDResolutionProver

func NewDIDResolutionProverRegistry

func NewDIDResolutionProverRegistry() *DIDResolutionProverRegistry

func (*DIDResolutionProverRegistry) Add

func (ch *DIDResolutionProverRegistry) Add(proofType verifiable.ProofType, prover DIDResolutionProver)

func (*DIDResolutionProverRegistry) Append

func (ch *DIDResolutionProverRegistry) Append(proofType verifiable.ProofType, prover DIDResolutionProver) error

func (*DIDResolutionProverRegistry) GetDIDResolutionProverByProofType

func (ch *DIDResolutionProverRegistry) GetDIDResolutionProverByProofType(proofType verifiable.ProofType) (DIDResolutionProver, error)

type DidDocumentOption

type DidDocumentOption func(*DidDocumentServices)

func WithProvers

func WithProvers(provers *DIDResolutionProverRegistry) DidDocumentOption

type DidDocumentServices

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

func NewDidDocumentServices

func NewDidDocumentServices(resolvers *ResolverRegistry, registry *ens.Registry, opts ...DidDocumentOption) *DidDocumentServices

func (*DidDocumentServices) GetDidDocument

func (d *DidDocumentServices) GetDidDocument(ctx context.Context, did string, opts *ResolverOpts) (*document.DidResolution, error)

GetDidDocument return did document by identifier.

func (*DidDocumentServices) GetGist

func (d *DidDocumentServices) GetGist(ctx context.Context, chain, network string, opts *ResolverOpts) (*verifiable.GistInfo, error)

func (*DidDocumentServices) ResolveDNSDomain

func (d *DidDocumentServices) ResolveDNSDomain(ctx context.Context, domain string) (*document.DidResolution, error)

ResolveDNSDomain return did document by domain via DNS.

func (*DidDocumentServices) ResolveENSDomain

func (d *DidDocumentServices) ResolveENSDomain(ctx context.Context, domain string) (*document.DidResolution, error)

ResolveENSDomain return did document via ENS resolver.

type GistInfo

type GistInfo struct {
	Root                *big.Int
	ReplacedByRoot      *big.Int
	CreatedAtTimestamp  *big.Int
	ReplacedAtTimestamp *big.Int
	CreatedAtBlock      *big.Int
	ReplacedAtBlock     *big.Int
}

func (*GistInfo) ToDidRepresentation

func (gi *GistInfo) ToDidRepresentation() (*verifiable.GistInfo, error)

type IdentityState

type IdentityState struct {
	StateInfo *StateInfo
	GistInfo  *GistInfo
}

type Resolver

type Resolver interface {
	Resolve(ctx context.Context, did w3c.DID, opts *ResolverOpts) (IdentityState, error)
	ResolveGist(ctx context.Context, opts *ResolverOpts) (*GistInfo, error)
	BlockchainID() string
}

type ResolverOpts

type ResolverOpts struct {
	State     *big.Int
	GistRoot  *big.Int
	Signature string
}

type ResolverRegistry

type ResolverRegistry map[string]Resolver

func NewChainResolvers

func NewChainResolvers() *ResolverRegistry

func (*ResolverRegistry) Add

func (ch *ResolverRegistry) Add(prefix string, resolver Resolver)

func (*ResolverRegistry) Append

func (ch *ResolverRegistry) Append(prefix string, resolver Resolver) error

func (*ResolverRegistry) GetResolverByNetwork

func (ch *ResolverRegistry) GetResolverByNetwork(chain, networkID string) (Resolver, error)

type StateInfo

type StateInfo struct {
	ID                  w3c.DID
	State               *big.Int
	ReplacedByState     *big.Int
	CreatedAtTimestamp  *big.Int
	ReplacedAtTimestamp *big.Int
	CreatedAtBlock      *big.Int
	ReplacedAtBlock     *big.Int
}

func (*StateInfo) ToDidRepresentation

func (si *StateInfo) ToDidRepresentation() (*verifiable.StateInfo, error)

type StateType

type StateType int32

const (
	IdentityStateType StateType = 0
	GlobalStateType   StateType = 1
)