decentralgabe / ledger-common

Credentialing objects and functions used in the Workday Credentials Platform. Exposes our usage of DIDs, Verifiable Credentials, Schemas, Presentation Exchange, Revocations, and more.

Ledger Common

Ledger Common is Workday Credentials' research open source library for credentialing and identity related functionality.

Overview

The Ledger Common repository houses definitions of common credentialing objects and functions for use in the Workday Credentialing Platform. The core object definitions implement data models defined in the W3C Verifiable Credentials and Decentralized Identifiers draft specifications. These object definitions will be updated over time as those specifications continue to evolve. This repository also holds some Workday internal data structures. The cryptographic functions are used to serialize and digitally sign these objects, and to subsequently verify those signatures.

Please note that this project is not actively maintained and should not be considered Workday production code.

Version

This library is currently in beta. It is unstable (no guarantee backwards compatibility).

Contributing

We invite anyone to raise issues or pull requests, but please note that this repo is only periodically monitored, and there is no guarantees of response to raised issues. See our full contribution guidelines.

Installation

$ go get -u github.com/workdaycredentials/ledger-common

Requirements

• Go 1.13+
• Mage

Mage

This library uses Mage as its build tool.

$ mage
Targets:
 build         builds the library.
 clean         deletes any build artifacts.
 packr         generates go files for static resources.
 packrClean    deletes all the packr generated go files.
 test          runs unit tests without coverage.

Packr

This library uses Packr to build our static assets.

Go binaries only contain content from .go files. Therefore, static resources like JSON Schemas need to be converted. The ledger-common code uses the packr library to abstract away the filesystem when accessing static resource files. The Packr tool will generate Golang files containing the contents of those resources. When a developer adds a new static resource file, they must call mage packr in order to generate new .go files. These generated files should be committed to source control in order to remove any dependency on the Packr tool in consumers of this library. As a convenience, Packr will automatically be installed using Gobin.

The mage packrclean command will delete all existing generated files.