verixyz.github.io

An official website for verixyz

Plugins

Addtional functionality in Verixyz is added to the Agent via the plugin system.

One can writing and configuraing pligin by their custom needs when builiding applications on Verixyz. Custom plugins can just live in a directory, private repository or on npm packages where can be shared with others.

Verixyz community encourage developers to follow some basic rules when writing/devolping plugins to ensure the whole ecosystem of highly interoperable functions.

Plugins Architecture

classDiagram
    Verixyz Agent <|-- IKeyManager
    Verixyz Agent <|-- IDataStore
    Verixyz Agent <|-- IDIDManager
    Verixyz Agent <|-- IResolver
    Verixyz Agent <|-- ICredentialIssuer
    Verixyz Agent : Messages
    Verixyz Agent : Identifiers
    Verixyz Agent : Credentials
    Verixyz Agent : Keys
    Verixyz Agent : Custom
    class IKeyManager{
        KMS{local,vault}
        KeyStore
    }
    class IDataStore{
        DBConnection{postgres}
    }
    class IDIDManager{
        DIDStore
        DIDProviders{WebDIDProvder,ethDIDProvider,keyProvider}
    }
    class IResolver{
        Resolver{WebDIDResolver}
    }
    class ICredentialIssuer{
        JWT
    }

Plugins API

All the plugins API reference should be seen on npmjs.

@verixyz/core#

@verixyz/did-manager#

@verixyz/did-provider-ethr#

@verixyz/did-provider-web#

@verixyz/did-provider-key#

@verixyz/key-manager#

@verixyz/kms-local#

@verixyz/did-resolver#

@verixyz/did-comm#

@verixyz/did-jwt#

@verixyz/message-handler#

@verixyz/url-handler#

@verixyz/selective-disclosure#

@verixyz/credential-w3c#

@verixyz/remote-server#

@verixyz/data-store#

@verixyz/remote-client#