feat: add support for hash, content type, and multiple URLs as service endpoints #235
Conversation
ntn-x2
added
✨ new feature
There was a problem hiding this comment.
I would move the URL checks to an implementation for ServiceEndPoints, see below.
I am also unsure, whether the VersionMigratorTrait should be in primitives. It probably should be moved to a new pallet Trait instead. We definitely need to make the migration template more generic and move most of the code to a Trait pallet eventually. Of course, this is out of scope for this PR.
Apart from that, LGTM.
| } | ||
| } | ||
|
|
||
| impl<T: Config> VersionMigratorTrait<T> for DidStorageVersion { |
There was a problem hiding this comment.
I will try to make this version migration more generic in the next week or future. But since we should wait for paritytech/substrate#9165 to be available in a release, it might not make sense to start with this before.
There was a problem hiding this comment.
Yes please, I think that would be great as we will eventually need it for other pallets as well. I can also take care of this if you don't manage to do it before you leave.
| total_weight | ||
| } | ||
|
|
||
| fn old_to_new_did_details<T: Config>(old: deprecated::v1::DidDetails<T>) -> DidDetails<T> { |
There was a problem hiding this comment.
I think we might not even need a migration since we just remove one field and initiate a new one with default None. But better to be safe.
There was a problem hiding this comment.
we need a migration here in case there are entries with a ServiceEndpointUrl. The new code would try to parse the URL into the new Struct.
| /// | ||
| /// In this way, the migrator can access the pallet's storage and the pallet's | ||
| /// types directly. | ||
| pub trait VersionMigratorTrait<T> { |
There was a problem hiding this comment.
Not sure whether we want to introduce a new Trait pallet for this instead.
There was a problem hiding this comment.
Perhaps it would make sense. But at the moment kilt_primitives was the only place I could put it in without creating any dependencies between KILT pallets. I guess also the storage migration stuff deserves to be put in a different crate, perhaps the same as the one for traits.
There was a problem hiding this comment.
Yes. I am fine leaving it be for this PR and then we handle it correctly in another PR.
| total_weight | ||
| } | ||
|
|
||
| fn old_to_new_did_details<T: Config>(old: deprecated::v1::DidDetails<T>) -> DidDetails<T> { |
There was a problem hiding this comment.
we need a migration here in case there are entries with a ServiceEndpointUrl. The new code would try to parse the URL into the new Struct.
fixes KILTProtocol/ticket#1505
This PR modifies the service endpoints of a DID by adding the possibility to specify a hash of the pointed service endpoints document, a content type to allow other entities to correctly parse the document, and up to three URLs to fetch the document from. The logic about what URL to use in case there are more than ones for a given resource are out of the scope of the chain code.
To do so, the PR updates the
DidVerificationKeyUpdateActionand makes it more generic into aDidFragmentUpdateAction<FragmentType>that is then used for both verification key updates withDidFragmentUpdateAction<DidVerificationKeyand for service endpoint updates withDidFragmentUpdateAction<ServiceEndpoints>, withServiceEndpointsbeing:I have not migrated this struct to use
BoundedVec, but I hope that is fine. We have one more parameter in the trait's Config calledMaxEndpointUrlsCountwhich specifies how many URLs can be included in aDidFragmentUpdateActionfor the service endpoints. We decided to go with three which seems like a reasonable number to provide good redundancy to the data.How to test:
cargo test --all --all-features --all-targetsor simplycargo test -p didCustom types
JS-Types
{ "AccountInfo": "AccountInfoWithTripleRefCount", "Address": "MultiAddress", "AmountOf": "i128", "Balance": "u128", "BlockNumber": "u64", "Index": "u64", "LookupSource": "MultiAddress", "CtypeCreatorOf": "AccountId", "CtypeHashOf": "Hash", "ClaimHashOf": "Hash", "AttesterOf": "AccountId", "AttestationDetails": { "ctypeHash": "CtypeHashOf", "attester": "AttesterOf", "delegationId": "Option<DelegationNodeIdOf>", "revoked": "bool" }, "Permissions": "u32", "DelegationNodeIdOf": "Hash", "DelegatorIdOf": "AccountId", "DelegateSignatureTypeOf": "Vec<u8>", "DelegationRoot": { "ctypeHash": "CtypeHashOf", "owner": "DelegatorIdOf", "revoked": "bool" }, "DelegationNode": { "hierarchyRootId": "DelegationNodeIdOf", "parent": "Option<DelegationNodeIdOf>", "children": "BTreeSet<DelegationNodeIdOf>", "details": "DelegationDetails" }, "DelegationDetails": { "owner": "DelegatorIdOf", "revoked": "bool", "permissions": "Permissions" }, "DelegationHierarchyDetails": { "ctypeHash": "CtypeHashOf" }, "KeyIdOf": "Hash", "DidIdentifierOf": "AccountId", "AccountIdentifierOf": "AccountId", "BlockNumberOf": "BlockNumber", "DidCallableOf": "Call", "DidVerificationKey": { "_enum": { "Ed25519": "[u8; 32]", "Sr25519": "[u8; 32]", "Ecdsa": "[u8; 33]" } }, "DidEncryptionKey": { "_enum": { "X25519": "[u8; 32]" } }, "DidPublicKey": { "_enum": { "PublicVerificationKey": "DidVerificationKey", "PublicEncryptionKey": "DidEncryptionKey" } }, "DidVerificationKeyRelationship": { "_enum": [ "Authentication", "CapabilityDelegation", "CapabilityInvocation", "AssertionMethod" ] }, "DidSignature": { "_enum": { "Ed25519": "Ed25519Signature", "Sr25519": "Sr25519Signature", "Ecdsa": "EcdsaSignature" } }, "DidError": { "_enum": { "StorageError": "StorageError", "SignatureError": "SignatureError", "UrlError": "UrlError", "InputError": "InputError", "InternalError": "Null" } }, "StorageError": { "_enum": { "DidAlreadyPresent": "Null", "DidNotPresent": "Null", "DidKeyNotPresent": "DidVerificationKeyRelationship", "VerificationKeyNotPresent": "Null", "CurrentlyActiveKey": "Null", "MaxTxCounterValue": "Null" } }, "SignatureError": { "_enum": [ "InvalidSignatureFormat", "InvalidSignature", "InvalidNonce" ] }, "KeyError": { "_enum": [ "InvalidVerificationKeyFormat", "InvalidEncryptionKeyFormat" ] }, "UrlError": { "_enum": [ "InvalidUrlEncoding", "InvalidUrlScheme" ] }, "InputError": { "_enum": [ "MaxKeyAgreementKeysLimitExceeded", "MaxVerificationKeysToRemoveLimitExceeded", "MaxUrlLengthExceeded" ] }, "DidPublicKeyDetails": { "key": "DidPublicKey", "blockNumber": "BlockNumberOf" }, "DidDetails": { "authenticationKey": "KeyIdOf", "keyAgreementKeys": "BTreeSet<KeyIdOf>", "delegationKey": "Option<KeyIdOf>", "attestationKey": "Option<KeyIdOf>", "publicKeys": "BTreeMap<KeyIdOf, DidPublicKeyDetails>", "serviceEndpoints": "Option<ServiceEndpoints>", "lastTxCounter": "u64" }, "DidCreationDetails": { "did": "DidIdentifierOf", "newKeyAgreementKeys": "BTreeSet<DidEncryptionKey>", "newAttestationKey": "Option<DidVerificationKey>", "newDelegationKey": "Option<DidVerificationKey>", "newServiceEndpoints": "Option<ServiceEndpoints>" }, "DidUpdateDetails": { "newAuthenticationKey": "Option<DidVerificationKey>", "newKeyAgreementKeys": "BTreeSet<DidEncryptionKey>", "attestationKeyUpdate": "DidFragmentUpdateAction<DidVerificationKey>", "delegationKeyUpdate": "DidFragmentUpdateAction<DidVerificationKey>", "publicKeysToRemove": "BTreeSet<KeyIdOf>", "serviceEndpointsUpdate": "DidFragmentUpdateAction<ServiceEndpoints>" }, "ServiceEndpoints": { "contentHash": "Hash", "urls": "Vec<Url>", "contentType": "ContentType" }, "DidFragmentUpdateAction": { "_enum": { "Ignore": "Null", "Change": { "_enum": [ "DidVerificationKey", "ServiceEndPoints" ] }, "Delete": "Null" } }, "ContentType": { "_enum": [ "ApplicationJson", "ApplicationJsonLd" ] }, "DidAuthorizedCallOperation": { "did": "DidIdentifierOf", "txCounter": "u64", "call": "DidCallableOf" }, "HttpUrl": { "payload": "Text" }, "FtpUrl": { "payload": "Text" }, "IpfsUrl": { "payload": "Text" }, "Url": { "_enum": { "Http": "HttpUrl", "Ftp": "FtpUrl", "Ipfs": "IpfsUrl" } }, "LockedBalance": { "block": "BlockNumber", "amount": "Balance" }, "BalanceOf": "Balance", "RoundInfo": { "current": "SessionIndex", "first": "BlockNumber", "length": "BlockNumber" }, "OrderedSet": "Vec<Stake>", "Stake": { "owner": "AccountId", "amount": "Balance" }, "TotalStake": { "collators": "Balance", "delegators": "Balance" }, "InflationInfo": { "collator": "StakingInfo", "delegator": "StakingInfo" }, "StakingInfo": { "maxRate": "Perquintill", "rewardRate": "RewardRate" }, "RewardRate": { "annual": "Perquintill", "perBlock": "Perquintill" }, "Delegator": { "delegations": "Vec<Stake>", "total": "Balance" }, "CollatorSnapshot": { "stake": "Balance", "delegators": "Vec<Stake>", "total": "Balance" }, "Collator": { "id": "AccountId", "stake": "Balance", "delegators": "Vec<Stake>", "total": "Balance", "state": "CollatorStatus" }, "CollatorStatus": { "_enum": { "Active": "Null", "Leaving": "SessionIndex" } }, "DelegationCounter": { "round": "SessionIndex", "counter": "u32" }, "DidStorageVersion": { "_enum": ["V1", "V2"] } }Checklist:
array[3]useget(3), ...)