chore: runtime API renaming #423
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 tasks
weichweich
approved these changes
Oct 17, 2022
Contributor
Author
|
@wischli this can now be cherry-picked as part of the 1.7.5 release 🎉 |
wischli
pushed a commit
that referenced
this pull request
Oct 17, 2022
* Add new DID runtime API name * Rename public credentials runtime API as well * Add deprecation comment * revert 'Rename public credentials runtime API as well'
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes https://github.com/KILTprotocol/ticket/issues/2243.
This PR adds a second runtime API for DIDs, which is meant to replace the
DidApiruntime API in the future.When this PR is deployed, the SDK can make DID runtime calls following the syntax specified in the issue linked above.
Because I would like to get this merged and released in 1.7.5 (before the SDK 0.29 is released), the node will support both versions (a minor change is needed to merge into
mastersince it does not have the Ethereum linking support yet). We can then remove the old version as part of the 1.8.0 release, but that will not require changes to the SDK since we would already use the new API in it.How to test
Take the types and runtime call definitions as defined in KILTprotocol/sdk-js#662 and use them in a simple node script. Try to call both the old API
api.call.didApi.queryDid(...)and the new oneapi.call.did.query(...), and they should yield the same result.