# Functions
AddByCollection option for grouping wallet contents by collection ID.
CreateDataVaultKeyPairs can be used create EDV key pairs for given profile.
CreateProfile creates a new verifiable credential wallet profile for given user.
FilterByCollection option for getting all contents by collection from wallet.
FromCredential option for deriving credential from a credential instance.
FromPresentation for sending aries verifiable presentation as message attachment.
FromRawCredential for deriving credential from raw credential bytes.
FromRawPresentation for sending raw JSON as presentation as message attachment.
FromStoredCredential for deriving credential from stored credential.
GetQueryType returns QueryType instance for given string query type.
New returns new verifiable credential wallet for given user.
NewDidComm returns new verifiable credential wallet for given user.
NewQuery returns new wallet query instance.
ProfileExists checks if profile exists for given wallet user, returns error if not found.
ResolveCredential options for resolving credential by given descriptor ID.
ResolveCredentialID options for resolving credential from wallet content store by given descriptor ID.
ResolveRawCredential options for resolving raw bytes of credential by given descriptor ID.
ResolveRawResponse options for resolving raw bytes of credential response presentation.
ResolveResponse options for resolving credential response presentation.
UpdateProfile updates existing verifiable credential wallet profile.
ValidateContent enables data model validations of adding content.
WaitForDone if provided then wallet will wait for credential interaction protocol status to be done or abandoned till given timeout.
WithConnectOptions for customizing options for accepting invitation.
WithConnectTimeout option providing connect timeout, to wait for connection status to be 'completed'.
WithCredentialsToProve option for providing verifiable credential instances for wallet to present.
WithEDVStorage option, for wallet profile to use EDV as storage.
WithFromDID option for providing customized from DID for sending propose message.
WithInitiateTimeout to provide timeout duration to wait for response for propose message.
WithKeyServerURL option, when provided then wallet will use remote kms for key operations.
WithMyLabel option for providing label to be shared with the other agent during the subsequent did-exchange.
WithPassphrase option to provide passphrase for local kms for key operations.
WithPresentationToProve option for providing presentation for wallet to present.
WithRawCredentialsToProve option for providing raw credential for wallet to present.
WithRawCredentialToVerify option for providing raw credential to be verified from wallet.
WithRawPresentationToProve option for providing raw presentation for wallet to present.
WithRawPresentationToVerify option for providing raw presentation to be verified from wallet.
WithReuseAnyConnection option to use any recognized DID in the services array for a reusable connection.
WithReuseDID option to provide DID to be used when reusing a connection.
WithRouterConnections option to provide for router connections to be used.
WithSecretLockService option, when provided then wallet will use local kms for key operations.
WithStoredCredentialsToProve option for providing stored credential IDs for wallet to present.
WithStoredCredentialToVerify option for providing ID of the stored credential to be verified from wallet.
WithUnlockByAuthorizationToken option for supplying remote kms auth token to open wallet.
WithUnlockByPassphrase option for supplying passphrase to open wallet.
WithUnlockBySecretLockService option for supplying secret lock service to open wallet.
WithUnlockEDVOptions can be used to provide custom aries edv options for unlocking wallet.
WithUnlockExpiry time duration after which wallet key manager will be expired.
WithUnlockWebKMSOptions can be used to provide custom aries web kms options for unlocking wallet.
# Constants
BbsBlsSignature2020 BBS signature suite.
supported key types for import key base58 (all constants defined in lower case).
Collection content type which can be used to group wallet contents together.
Connection content type for handling wallet connection data models.
Credential content type for handling credential data models.
DIDAuth https://w3c-ccg.github.io/vp-request-spec/#did-authentication-request.
DIDResolutionResponse content type for handling DID document data models.
Ed25519Signature2018 ed25519 signature suite.
supported key types for import key base58 (all constants defined in lower case).
EmbeddedLDProofFormat indicates that a credential or presentation should be signed with an embedded LD proof.
ExternalJWTProofFormat indicates that a credential or presentation should be signed with an external JWT proof.
JSONWebSignature2020 json web signature suite.
Key content type for handling key data models.
Metadata content type for handling wallet metadata data models.
PresentationExchange https://identity.foundation/presentation-exchange/.
QueryByExample https://w3c-ccg.github.io/vp-request-spec/#query-by-example.
QueryByFrame https://github.com/w3c-ccg/vp-request-spec/issues/8.
# Variables
ErrAlreadyUnlocked error when key manager is already created for a given user.
ErrInvalidAuthToken when auth token provided to wallet is unable to unlock key manager.
ErrProfileNotFound error for wallet profile not found scenario.
ErrQueryNoResultFound error when no records found from query.
ErrWalletLocked when key manager operation is attempted without unlocking wallet.
# Structs
CredentialInteractionStatus holds the status of credential share/issuance interaction from wallet.
DeriveOptions model containing options for deriving a credential.
DidComm enables access to verifiable credential wallet features.
ExampleDefinition frame for QueryByExample.
GenericInvitation holds either a DIDComm V1 or V2 invitation.
KeyPair is response of creating key pair inside wallet.
ProofOptions model
Options for adding JWT or linked data proofs to a verifiable credential or a verifiable presentation.
Query performs wallet credential queries, currently supporting all the QueryTypes defined in QueryType.
QueryByExampleDefinition is model for QueryByExample query type.
QueryByFrameDefinition is model for QueryByExample query type.
QueryParams contains credential queries for querying credential from wallet.
Session represent a session object created when user unlock wallet.
TrustedIssuerDefinition is model for trusted issuer component in QueryByFrame & QueryByExample.
Wallet enables access to verifiable credential wallet features.
# Type aliases
AddContentOptions is option for adding contents to wallet.
ConcludeInteractionOptions is option to conclude credential interaction between wallet and verifier/issuer by sending present proof or request credential message.
ConnectOptions options for accepting incoming out-of-band invitation and connecting.
ContentType is wallet content type.
CredentialToDerive is credential option for deriving a credential from wallet.
GetAllContentsOptions is option for getting all contents from wallet.
InitiateInteractionOption options for initiating credential interaction by proposing presentation/credential from wallet.
ProfileOptions is option for verifiable credential wallet key manager.
ProofFormat determines whether a credential or presentation should be signed with an external JWT proof (wrapping the credential to form a JWT-VC) or with an embedded LD proof.
ProveOptions options for proving credential to present from wallet.
QueryType is type of query supported by wallet implementation More details can be found here : https://w3c-ccg.github.io/universal-wallet-interop-spec/#query.
ResolveManifestOption is option to resolve credential manifests.
UnlockOptions is option for unlocking verifiable credential wallet key manager.
VerificationOption options for verifying credential from wallet.