0.28.3

This is a patch release that fixes the polkadot dependencies to work with the latest node release 1.7.5.

If not upgrading to the upcoming SDK v0.29, please update to this version to work with Peregrine and with Spiritnet after runtime 1.7.5 has been enacted.

0.29.0-rc.3

This release candidate adds some last features and refactorings to what is to become release 0.29.0. Mostly we have changed function- and callback signatures on the basis of feedback on the rc.2. We also simplified the CType interface and removed obsolete wrapper functions for querying DIDs, web3 names, and linked accounts, that can now easily be queried using a new runtime call deployed for that purpose.

What's Changed

• feat!: callback feedback by @tjwelde in #647
• feat!: throw instead of return null by @arty-name in #648
• feat!: verify* functions take didResolveKey parameter by @arty-name in #651
• refactor!: simplify CType by @rflechtner in #656
• refactor!: remove queries for did, web3names, and didLookup in favor of the api.call.didApi call by @arty-name in #643
• refactor!: make verifyDidSignature accept Uint8Array by @rflechtner in #666
• feat: add new potential type definitions by @ntn-x2 in #662
• feat: added KiltEncryptionKeypair by @arty-name in #646
• feat: align from *Extrinsic to *Tx method names by @arty-name in #602
• feat: remove Did.signPayload by @tjwelde in #641
• feat: vc exporter - exports by @Dudleyneedham in #466
• chore: rename DidBuilderError by @arty-name in #650
• chore: pin type-definitions to same version by @rflechtner in #654
• chore: add type definitions inside the monorepo by @ntn-x2 in #658
• chore: remove strictResolve by @rflechtner in #664
• chore: bump typescript-logging to v1 by @rflechtner in #667
• chore: 0.29.0-rc.3 by @rflechtner in #668
• fix: missing JSDoc annotations and other lints by @arty-name in #649
• fix: augmented types by @tjwelde in #652
• fix: metadata update command in weekly tests by @rflechtner in #655
• fix: checkout v1 seems broken by @rflechtner in #661
• fix: update type definitions by @ntn-x2 in #659

Full Changelog: 0.29.0-rc.2...0.29.0-rc.3

0.29.0-rc.2

This part of the SDK refactoring removes lots of chain wrappers for transactions and queries.
Users of the SDK will be asked to work with the blockchain more directly. To support that, we already added type augmentations for our blockchain calls are updating our documentation.

What's Changed

• feat: add KiltPublishedCredentialV1 and KiltPublishedCredentialCollectionV1 types by @ntn-x2 in #631
• feat!: remove 40+ basic chain wrappers by @arty-name in #613
• fix: selective disclosure by @rflechtner in #630
• feat: Did.uriFromChain and encode replaces type cast by @arty-name in #633
• feat: avoid .hash().isEmpty by @arty-name in #634
• fix: update type of published credential and export constant by @ntn-x2 in #635
• refactor!: remove more chain wrappers by @arty-name in #636
• feat: derive KeyRelationship for batched calls by @weichweich in #628
• refactor!: verify* throws by @rflechtner in #632
• feat: simplify sign and encrypt callbacks by @tjwelde in #624
• feat: add DID RPC decorations by @ntn-x2 in #637
• feat!: export ConfigService from the SDK by @arty-name in #638
• feat: utilities for KiltKeyringPair by @arty-name in #639
• refactor!: single DID namespace by @arty-name in #640
• feat: message.decrypt does not need did document by @tjwelde in #645

Full Changelog: 0.29.0-rc.1...0.29.0-rc.2

0.29.0-rc.1

We have been working on a big SDK refactoring, to make it more slim, easy-to-use and easier to maintain.
The biggest focus was on changing everything from OOP to functional style and to make handling of DIDs easier.

Some changes are still to come, including a more hand-off approach to blockchain queries and transactions.

What's Changed

• feat: conventional/semantic PR titles by @arty-name in #560
• feat: no classes for core types by @tjwelde in #471
• feat: remove Blockchain class and re-signing by @arty-name in #549
• feat: remove Keystore by @arty-name in #555
• feat: use jest.mocked() by @arty-name in #561
• feat: use arrow functions shorthand by @arty-name in #565
• feat: ss58Format constant by @arty-name in #562
• feat: replace .then() with await by @arty-name in #566
• feat: remove unnecessary const types by @arty-name in #564
• feat: remove unnecessary use of .resolves by @arty-name in #567
• test: allow running integration tests against a single endpoint by @rflechtner in #558
• feat: prefer named functions over arrow functions by @arty-name in #568
• fix: light DID serialization types by @arty-name in #570
• fix: collect keyReferences efficiently by @arty-name in #571
• fix: common integration tests issues by @arty-name in #573
• fix: grammar and spelling errors by @arty-name in #572
• feat: remove enums by @arty-name in #574
• feat: use DID types directly by @arty-name in #575
• chore: use esnext as target & lib in tsconfig by @tjwelde in #579
• feat!: idiomatic consistent errors by @arty-name in #577
• chore(deps): remove unused dependencies by @rflechtner in #580
• fix!: rename service endpoint URLs to URIs by @arty-name in #569
• feat: augmented api using @polkadot/typegen by @rflechtner in #554
• feat: support account link pallet update by @rflechtner in #557
• feat!: request for attestation -> credential by @tjwelde in #563
• feat: clarity in Credential.verify by @tjwelde in #587
• chore(deps): update polkadot dependencies to v9 by @renovate in #586
• fix: testcontainer startup await once and for all by @rflechtner in #591
• feat!: remove DidBatcher by @arty-name in #581
• refactor: transpile jsonabc by @rflechtner in #589
• refactor: did enum types by @tjwelde in #582
• feat!: DID classes -> Document* + functions by @arty-name in #585
• feat: use finalization defaults by @arty-name in #595
• fix: more realistic bundle tests by @arty-name in #596
• feat!: drop keySelection by @arty-name in #598
• feat!: replace resolver with resolve by @arty-name in #599
• feat!: remove identifier from DidDetails by @arty-name in #600
• fix: capitalization of DID by @arty-name in #603
• feat!: replace function calls with map lookups by @arty-name in #604
• feat: improved Did.chain.ts by @arty-name in #608
• feat: convert Message to functional style by @tjwelde in #597
• feat(message)!: separate verify function by @tjwelde in #611
• fix: augmentation hacks by @rflechtner in #601
• feat: do not assert codec type by @arty-name in #606
• feat!: better account linking by @arty-name in #605
• feat: no support for the old delegations format by @arty-name in #617
• fix: verifyDidSignature check by @arty-name in #609
• feat!: rename DidDetails to DidDocument by @arty-name in #620
• feat!: remove all compression & decompression by @tjwelde in #616
• feat: strict boolean checks by @arty-name in #612
• chore: upgrade CI to use node v18 by @tjwelde in #621
• refactor!: do not auto-manage api connection by @rflechtner in #622
• chore(deps): update dependency uuid to v9 by @renovate in #619
• feat: streamline resolution of DIDs, keys, endpoints by @arty-name in #607
• feat!: replace checkValidity with query + assertions by @tjwelde in #623
• style: use the base tsconfig for eslint type info by @tjwelde in #626
• chore!: type guards should not throw by @rflechtner in #625
• feat: default tx subscription resolution config by @rflechtner in #627
• feat!: presentations by @rflechtner in #618

Full Changelog: 0.28.2...0.29.0-rc.1

0.28.2

What's Changed

This is a patch release resolving issues arising from most bundlers not including *.cjs source files by default, leading to applications importing the sdk not being bundled correctly without additional configuration.

• refactor: transpile jsonabc (589) by @rflechtner

Full Changelog: 0.28.1...0.28.2

0.28.1

What's Changed

• Hotfix (#576) bumps all direct dependencies of polkadot-js/api packages to ^8.12.0 and all direct dependencies of polkadot-js/common to ^10.0.0.
  • This was required due to polkadot-js/api packages depending on v9 of polkadot-js/common prior to version 8.12.0 but on v10 versions since. As a result, highly problematic dependency duplication could only be avoided in 0.28.0 if resolving polkadot-js/api to 8.11 and below.

Full Changelog: 0.28.0...0.28.1

0.28.1-rc.1

What's Changed

• chore(deps): update polkadot dependencies to v10 by @renovate in #576

Full Changelog: 0.28.0...0.28.1-rc.1

0.28.0

❗️❗️❗️ Upgrading to this SDK version is required for apps that rely on instance of the KILT blockchain running at least the runtime version 1.7.0 ❗️❗️❗️

For an example update PR from 0.27 to 0.28, you can refer to our docs PR.

Summary of changes

Among other things, these renaming happened:

• FullDidCreationBuilder.consumeWithHandler -> buildAndSubmit
• DidBatchBuilder.consume -> build
• DidDetails.did -> uri (so also FullDidDetails and LightDidDetails)
• Did.DidChain -> Did.Chain
• Did.DidUtils -> Did.Utils
• IDidIdentifier -> DidIdentifier
• Kilt.Did.AccountLinks.authorizeLinkWithAccount -> getAuthorizeLinkWithAccountExtrinsic
• Kilt.Did.AccountLinks.getAssociateSenderTx -> getAssociateSenderExtrinsic
• Kilt.Did.AccountLinks.getLinkRemovalByDidTx -> getLinkRemovalByDidExtrinsic

What's Changed

Features

• feat: string pattern types for did uri, did resource uri, and hex string by @rflechtner in #505
• feat: convert SDKErrors to just extend Error by @tjwelde in #535
• feat: recover compatibility with new attestation pallet by @rflechtner in #544
• feat: attestation module flexibly handles old delegation pallet by @rflechtner in #550
• feat: check service urls by @rflechtner in #506

Chores

• chore: QOL improvements by @ntn-x2 in #486
• chore: remove symmetric crypto by @rflechtner in #498
• dedupe dependencies in lockfile by @rflechtner in #474
• refactor: consistent naming by @weichweich in #520
• refactor: no throw in verify by @weichweich in #516
• chore: remove all @example jsdocs by @trusch in #523
• Update license by @rflechtner in #532
• docs: add docstrings to all public functions and methods by @rflechtner in #534
• docs: remove outdated docs by @ntn-x2 in #540
• packageManager: [email protected] by @arty-name in #548
• chore(deps): update polkadot dependencies by @renovate in #529
• chore: fixed spelling by @arty-name in #553

Internal Improvements

• test against updated dependencies by @rflechtner in #481
• ci: create issue on failing dependency tests by @rflechtner in #493
• chore: add release candidate workflow by @ntn-x2 in #495
• test: test the sdk bundle by @LeonFLK in #424
• ci: improvements for scheduled workflow by @rflechtner in #507
• feat: add renovate config by @rflechtner in #518
• fix: dev release pipeline by @ntn-x2 in #500
• feat: use testcontainers for integration testing by @rflechtner in #517
• chore(tsconfig): only include packages of interest by @tjwelde in #536
• ci: Trigger doc test whenever a new tag is added by @ggera in #539
• fix: trigger docs tests only on releases by @ntn-x2 in #543
• feat: convert bundle test to TS by @arty-name in #551

Fixes

• ci: fix metadata update on scheduled tests by @rflechtner in #513
• fix: repair tsdoc generation by @trusch in #515
• fix: deposit amount test by @arty-name in #556
• fix: accept fragment as typeguard for some methods and add retro-compatibility for DID signatures by @ntn-x2 in #559

New Contributors

• @ggera made their first contribution in #539

Full Changelog: 0.27.0...0.28.0

0.28.0-rc.2

What's Changed

• fix: accept fragment as typeguard for some methods and add retro-compatibility for DID signatures by @ntn-x2 in #559

Full Changelog: 0.28.0-rc.1...0.28.0-rc.2

0.28.0-rc.1

This release contains some bigger changes.
A lot of function names have been renamed and the custom SDKErrors with error codes were replaced by sub-classing the native Error class.

What's Changed

Features

• feat: add SDK runtime checks for BoundedVec RPC limits by @ntn-x2 in #496
• feat: string pattern types for did uri, did resource uri, and hex string by @rflechtner in #505
• refactor: consistent naming by @weichweich in #520
• refactor: no throw in verify by @weichweich in #516
• feat: convert SDKErrors to just extend Error by @tjwelde in #535
• feat: do not require process to be available by @tjwelde in #542
• feat: recover compatibility with new attestation pallet by @rflechtner in #544
• feat: attestation module flexibly handles old delegation pallet by @rflechtner in #550
• feat: check service urls by @rflechtner in #506

Chores

• chore: QOL improvements by @ntn-x2 in #486
• chore: remove symmetric crypto by @rflechtner in #498
• chore: remove all @example jsdocs by @trusch in #523
• docs: add docstrings to all public functions and methods by @rflechtner in #534
• docs: remove outdated docs by @ntn-x2 in #540
• chore(deps): update polkadot dependencies by @renovate in #529

Bug Fixes

• fix: repair tsdoc generation by @trusch in #515

New Contributors

• @ggera made their first contribution in #539
• @renovate made their first contribution in #529

Full Changelog: 0.27.0...0.28.0-rc.1