package
6.0.0-beta.10+incompatible
Repository: https://github.com/nuts-foundation/nuts-node.git
Documentation: pkg.go.dev

# Functions

ByServiceType returns a predicate that matches on service type it only matches on DID Documents with a concrete endpoint (not starting with "did").
GetDIDFromURL returns the DID from the given URL, stripping any query parameters, path segments and fragments.
IsActive returns a predicate that matches DID Documents that are not deactivated.
IsDeactivated returns true if the DID.Document has already been deactivated.
IsFunctionalResolveError returns true if the given error indicates the DID or service not being found or invalid, e.g.
IsServiceReference checks whether the given endpoint string looks like a service reference (e.g.
MakeServiceReference creates a service reference, which can be used as query when looking up services.
NewMockDIDResolver creates a new mock instance.
NewMockDocFinder creates a new mock instance.
NewMockKeyResolver creates a new mock instance.
NewMockNutsKeyResolver creates a new mock instance.
NewMockPredicate creates a new mock instance.
NewMockServiceResolver creates a new mock instance.
ValidAt returns a predicate that matches on validity period.
ValidateServiceReference checks whether the given URI matches the format for a service reference.

# Constants

No description provided by the author
No description provided by the author
BaseURLServiceType is type of the DID service which holds the base URL of the node's HTTP services, exposed to other Nuts nodes.
No description provided by the author
No description provided by the author
DefaultMaxServiceReferenceDepth holds the default max.
No description provided by the author
NutsSigningKeyType defines the verification method relationship type for signing keys in Nuts DID Documents.

# Variables

ErrDeactivated signals rejection due to document deactivation.
ErrDIDMethodNotSupported is returned when a DID method is not supported by the DID resolver.
ErrDIDNotManagedByThisNode is returned when an operation needs the private key and if is not found on this host.
ErrDuplicateService is returned when a DID Document contains a multiple services with the same type.
ErrKeyNotFound is returned when a particular key or type of key is not found.
ErrNoActiveController The DID supplied to the DID resolution does not have any active controllers.
ErrNotFound The DID resolver was unable to find the DID document resulting from this resolution request.
ErrServiceNotFound is returned when the service is not found on a DID.
ErrServiceReferenceToDeep is returned when a service reference is chain is nested too deeply.

# Structs

ChainedDIDResolver is a DID resolver that tries to resolve the DID with multiple resolvers.
DIDKeyResolver implements the DIDKeyResolver interface that uses keys from resolved DIDs.
DIDResolverRouter is a DID resolver that can route to different DID resolvers based on the DID method.
DIDServiceResolver is a wrapper around a DID store that allows resolving services, following references.
DocumentMetadata holds the metadata of a DID document.
MockDIDResolver is a mock of DIDResolver interface.
MockDIDResolverMockRecorder is the mock recorder for MockDIDResolver.
MockDocFinder is a mock of DocFinder interface.
MockDocFinderMockRecorder is the mock recorder for MockDocFinder.
MockKeyResolver is a mock of KeyResolver interface.
MockKeyResolverMockRecorder is the mock recorder for MockKeyResolver.
MockNutsKeyResolver is a mock of NutsKeyResolver interface.
MockNutsKeyResolverMockRecorder is the mock recorder for MockNutsKeyResolver.
MockPredicate is a mock of Predicate interface.
MockPredicateMockRecorder is the mock recorder for MockPredicate.
MockServiceResolver is a mock of ServiceResolver interface.
MockServiceResolverMockRecorder is the mock recorder for MockServiceResolver.
ResolveMetadata contains metadata for the resolver.
ServiceQueryError denies the query based on validation constraints.

# Interfaces

DIDResolver is the interface for DID resolvers: the process of getting the backing document of a DID.
DocFinder is the interface that groups all methods for finding DID documents based on search conditions.
KeyResolver is the interface for resolving keys.
NutsKeyResolver is the interface for resolving keys from Nuts DID Documents, supporting Nuts-specific DID resolution parameters.
Predicate is an interface for abstracting search options on DID documents.
ServiceResolver allows looking up DID document services, following references.

# Type aliases

DocIterator is the function type for iterating over the all current DID Documents in the store.
RelationType is the type that contains the different possible relationships between a DID Document and a VerificationMethod They are defined in the DID spec: https://www.w3.org/TR/did-core/#verification-relationships.