1.0.0

Release Notes for Version 1.0.0

To reduce the complexity of our SDK and improve its user-friendliness, we've redesigned its user-facing interfaces. Version 1.0.0 of @kiltprotocol/sdk-js comes with a streamlined surface that supports long-term maintainability. This includes a shift towards higher-level functions that conceal much of the underlying complexity.

As part of this effort, we've transitioned to exclusively using KILT credentials in their W3C Verifiable Credentials Data Model V1.1 representation. Credentials using the traditional format can be converted to and from the VC data model format using the new @kiltprotocol/legacy-credentials package.

Comprehensive documentation and migration instructions will be provided soon on docs.kilt.io.

What has changed

• @kiltprotocol/sdk-js version 1.0.0 introduces a much cleaner, curated surface comprised only of high-level functions.
• Lower-level functions can be imported directly from its constituent packages, for which we release versions 0.100.0.
• New releases of existing packages:
  • @kiltprotocol/did
  • @kiltprotocol/chain-helpers
  • @kiltprotocol/types
  • @kiltprotocol/config
  • @kiltprotocol/utils
• Releases of new packages:
  • @kiltprotocol/credentials: Provides functionality to issue and verify Verifiable Credentials and Verifiable Presentations; helps with creating and loading CTypes.
  • @kiltprotocol/legacy-credentials: Provides legacy credential functionality formerly provided by @kiltprotocol/core.
  • @kiltprotocol/asset-credentials: Provides functionality around Asset DIDs and Asset Credentials.
  • @kiltprotocol/jsonld-suites: Provides helpers for issuing and verifying KILT credentials using @digitalbazaar/vc.
• The following packages have been discontinued or moved:
  • @kiltprotocol/augment-api & @kiltprotocol/type-definitions: Moved into a new repository (KILTprotocol/types-augment).
  • @kiltprotocol/vc-export: Discontinued; most functionality moved to @kiltprotocol/jsonld-suites, conversion between VCs and legacy credentials has moved to @kiltprotocol/legacy-credentials.
  • @kiltprotocol/asset-did: Discontinued; moved into @kiltprotocol/asset-credentials.
  • @kiltprotocol/core: Discontinued; most functions have moved into @kiltprotocol/legacy-credentials; CType-related functions have moved to @kiltprotocol/credentials; functions relating to connecting to a blockchain node have moved to @kiltprotocol/chain-helpers.
  • @kiltprotocol/messaging: Discontinued; functionality has been moved to @kiltprotocol/kilt-extension-api.

Changelog

chore: release v1 by @rflechtner in #897

Full Changelog: 0.35.2...1.0.0

Contributors

@rflechtner
@abdulmth
@ntn-x2
@arty-name
@tjwelde
@Dudleyneedham