Skip to content

v0.19.0 (2020-08-05)
Compare
Choose a tag to compare
@tjwelde tjwelde released this 05 Aug 12:19
· 894 commits to develop since this release
0.19.0
069e9e5

Overview

This release is a big one. We included new features, security improvements, dependency updates for substrate 2 compatibility and more tests.

Substrate 2

In regards to our substrate 2 chain update, we updated all our dependencies to be compatible to that.

Privacy enhanced credentials (Portablegabi)

We integrated an option to use fully anonymous credentials, we call "privacy enhanced credentials", based on our portablegabi library, which itself is based on Gabi Go from the Privacy By Design Foundation

Nested CTypes

You are now able to reference another CType in a field of a CType. This requires them to use a unique URI like string in the $id field, which we are generating for you. You can reference another CType with the $ref key.

Input checks

All our classes now check in the constructor, if the provided parameters are of expected type and format. You can also use new custom typeguards, to check if some data is of a specific type yourself, e.g. Attestation.isAttestation(data).

Compress / Decompress objects

For easier storage of objects, they can now be converted to a simple object presentation of themselves. To turn them back into class instances, you can use the decompress functions.

Changelog

BREAKING CHANGES

  • CTypes now require a URI-like string in the $id field. This has to be in the format kilt:ctype:0x123456 with the hex part being the hash of the ctype schema. This $id is generated for you, when using the CType.fromSchema function. You can also generate it yourself with CTypeUtils.getIdForSchema(schema).
  • refactor message encryption and decryption (#276) (b029028)
    • message.getEncryptedMessage renamed to message.encrypt
    • Message.createFromEncryptedMessage renamed to Message.decrypt
    • include Message.ensureHashAndSignature and Message.ensureOwnerIsSender in decrypt per default
  • listenToBalanceChanges now returns the unsub method so that listeners can unsubscribe, the listener parameter is now required

Features

Major

  • add optional privacy enhancement by implementing anonymous credentials from portablegabi (#258) (0cb1b2e)
    • opt-in by default (#292) (8e5d788)
    • adds multi-show unlinkability and selective disclosure to KILT credentials
    • see docs/example.ts for code
  • add Nested CTypes (#222) (4a09b7b)
    • enable users to link pre-existing CTypes to create deeper nested data structures
  • add compression and decompression of objects (#240) (3d28420)
  • add type checks on chain queries + improvements to static typing (#260) (791206c) and (#286) (15bfc92)
  • add constructor input checks (601f30a)
  • replace TxStatus with SubmittableResult (#250) (82c3d59)
  • add query of delegation root id (#276) (f8e96f6) 
    Attestation.getDelegationRoot(delegationId)

Minor

  • summarize errors in SDKErrors (a5b4ff2)
  • add index filed (fb21ee9)
  • reject attestation should reference the request (122ba69)
  • add required fields from ctype schema to wrapper schema (#272) (f1ba0d9)
    • some fields were not marked as required before
  • copy jsonabc into project (#293) (a32f8af)
  • publish develop branch to github packages (#274) (5b84729)
  • add dockerfile for running integration tests (#254) (2acbafb)

Bug Fixes

Minor

  • ctype compress accepts nulled owner (1eb044a)
  • getCached returns BlockchainApi instead of Blockchain (#270) (76e65b6)
  • leaked subscription (#266) (edbc02a)
  • getPublicIdentity should be instanceof PublicIdentity instead of object (#264) (b4f4d0c)

Tests

  • better blockchain api mocking (#255) (58a2176)
  • add more integration tests
  • improve unit test coverage to ~90%
Assets 3
Loading