feat: asset DIDs and public credentials #378

ntn-x2 · 2022-07-08T14:04:38Z

fixes KILTProtocol/ticket#2029

This PR introduces the following components:

A new crates folder which contains additional crates we work on and might want to offer to the community. In this case, the hope is that the Asset DID crate would be migrated to the Substrate repo eventually
A new public-credentials pallet which stores credentials issued to assets as defined in the draft
A new RPC module to fetch either a single credential entry (i.e., block number + deposit info) for a given (subject and root hash), or all credentials (i.e., a vector of(root hash, credential entry) for a given subject.

Pallet

The new pallet exposes the following extrinsics:

// Internally calls authorization::add() and fails if that call fails
fn add(credential: InputCredential);
// Internally calls authorization::remove() and fails if that call fails
fn remove(claim_hash: Hash, ac: Option<AccessControl>);
// Internally calls authorization::reclaim_deposit() and fails if that call fails
fn reclaim_deposit(claim_hash: Hash);

EDIT: with the merge of #392, two new extrinsics will be added, and the claim_hash is replaced by the credential_id:

fn add(credential: InputCredential);
fn remove(credential_id: Hash, ac: Option<AccessControl>);
fn reclaim_deposit(credential_id: Hash);
fn revoke(credential_id: Hash,  ac: Option<AccessControl>);
fn unrevoke(credential_id: Hash,  ac: Option<AccessControl>);

The InputCredential type is the following:

{
    "claim": {
        "ctype_hash": "0ab12...",
        "subject": "did:asset:...",
        "contents": "0ab12...",        // Encoded claims
    },
    "nonce": "0ab12....",
    "claim_hash": "0ab12...",
    // OPTIONAL
    "claimer_signature": {
        "claimer_id": "4fa..."        // Full DID (with no did:kilt: prefix of the claimer)
        "signature_payload": MultiSignature    // The usual signature type we use everywhere else
    },
    // OPTIONAL
    "authorization_info": AuthorizationInfo
}

EDIT: with the merge of #392, the format will be changed to:

{
    "ctype_hash": "0ab12...",
    "subject": "did:asset:...",
    "contents": "0ab12...",        // Encoded claims
    // OPTIONAL
    "authorization_info": AuthorizationInfo
}

RPC

The RPC exposes the following functions:

get_credential(subject_id, root_hash) -> Option<CredentialEntry>
get_credentials(subject_id) -> Vec<(RootHash, CredentialEntry)>

EDIT: with the merge of #392, the RPC endpoints will be:

get_credential(credential_id) -> Option<CredentialEntry>
get_credentials(subject_id, filter) -> Vec<(RootHash, CredentialEntry)>

For update examples see the description of #392.

…c-credentials-v2

weichweich

Some questions and some minor comments. But I also think the proxy filter is wrong? That needs to be changed.

Will give it another run after our call, but looks good initially. 🐝

weichweich · 2022-08-09T08:40:07Z

nodes/parachain/src/rpc.rs

+			// Input subject ID
+			String,
+			// Runtime subject ID
+			runtime_common::assets::AssetDid,


Any reason for using the qualified path here and not simply AssetDid?

weichweich · 2022-08-30T06:02:56Z

crates/assets/src/asset.rs

+		Generic(GenericAssetId),
+	}
+
+	impl From<Slip44Reference> for AssetId {


The cherry 🍒 on top: I think there is a way to derive the from impl for each enum variant. You only implemented it for two because those are useful right now?

Yeah good to know, but the problem is that not all references are unambiguous. For instance an EvmSmartContractNonFungibleReference could refer to either an Erc721 or an Erc1155 asset type.

weichweich · 2022-08-30T06:05:59Z

crates/assets/src/asset.rs

+				(Some(SLIP44_NAMESPACE), Some(slip44_reference), identifier) => {
+					if identifier.is_some() {
+						log::trace!("Slip44 namespace does not accept an asset identifier.");
+						Err(Error::InvalidFormat)
+					} else {
+						Slip44Reference::from_utf8_encoded(slip44_reference).map(Self::Slip44)
+					}
+				}


I would separate them using a comment but use match through out the whole thing and not nest it with if

weichweich · 2022-08-30T06:18:13Z

crates/assets/src/asset.rs

+				(Some(SLIP44_NAMESPACE), Some(slip44_reference), identifier) => {
+					if identifier.is_some() {
+						log::trace!("Slip44 namespace does not accept an asset identifier.");
+						Err(Error::InvalidFormat)
+					} else {
+						Slip44Reference::from_utf8_encoded(slip44_reference).map(Self::Slip44)
+					}
+				}


Alternativ: don't use if but something like 'ensure!()'

weichweich · 2022-08-30T08:20:57Z

crates/assets/src/v1.rs

+		match (chain, asset) {
+			(Some(chain), Some(asset)) => {
+				let chain_id = ChainId::from_utf8_encoded(chain).map_err(AssetDidError::ChainId)?;
+				let asset_id = AssetId::from_utf8_encoded(asset).map_err(AssetDidError::AssetId)?;
+				Ok(Self { chain_id, asset_id })
+			}
+			_ => Err(AssetDidError::InvalidFormat),
+		}


The easier extend is not an argument IMHO since the work to change a if-else to match is something any future dev can do. 😁 I also think we should stick with the linter rule.

runtimes/common/src/authorization.rs

runtimes/spiritnet/src/lib.rs

runtimes/peregrine/src/lib.rs

runtimes/standalone/src/lib.rs

…c-credentials-v2

wischli

LGTM!

wischli · 2022-09-20T06:19:32Z

pallets/attestation/Cargo.toml

 name = "attestation"
-repository = "https://github.com/KILTprotocol/kilt-node"
-version = "1.7.1"
+repository = "https://github.com/KILTprotocol/mashnet-node"


I suppose this is an inherent error from my update. There are many more. But we can handle this in a separate PR.

Suggested change

repository = "https://github.com/KILTprotocol/mashnet-node"

repository = "https://github.com/KILTprotocol/kilt-node"

Re-fixed in 3b1ab07.

weichweich

Still loving it

rpc/did/Cargo.toml

weichweich · 2022-09-20T07:05:10Z

rpc/public-credentials/Cargo.toml

+sp-runtime = {git = "https://github.com/paritytech/substrate", default-features = false, branch = "polkadot-v0.9.28"}
+
+# Internal runtime dependencies
+public-credentials-runtime-api = {version = "1.7.2", path = "./runtime-api"}


Suggested change

public-credentials-runtime-api = {version = "1.7.2", path = "./runtime-api"}

public-credentials-runtime-api = {path = "./runtime-api"}

ntn-x2 added 30 commits June 9, 2022 16:59

wip: skeleton in place

19d857d

wip: trying to fight with rust-analyzer

98c24ce

wip: FFS

8704a4d

Merge commit '52a47659becda33033a269c7d8152dcf5493d0b9' into aa/publi…

39691f2

…c-credentials-v2

wip: tests for the new pallet

323296d

test: add unit tests for the new pallet

b586fb2

chore: fmt

d01497b

fix: restore toolchain to nightly

e2d56a2

core: clippy

7bc2e70

wip: minor chores

f98c1e7

test: add hcecks for deposit reservations

21aeb3a

test: add InvalidInput test case

bb4d421

feat: working on parsing the right chain_id information

c16dd8d

feat: add dotsama and solana chains

6d07577

feat: generic chain support

1ca4a9e

feat: add utility functions for chain IDs

bc3b0c6

chore: clippy + fmt

ba3fb49

fix: uncomment remaining test functions

f9878c9

wip: first version of new pallet

18c7326

feat: new pallet for chain IDs

eed9719

wip: fixing last issues

918fff0

fix: chain ids now working fine

b9ae971

feat: asset id complete (untested)

a43f2af

most of unit tests for asset IDs in

df4f1aa

test: unit tests passing

cd0748b

wip: almost complete

948832a

chore: small improvements

031e851

feat: default implementations of important traits

f38741f

chore: few needed adjustments

dc49855

test: add test for too long credentials

feb4759

ntn-x2 added 8 commits August 10, 2022 08:47

Update public credentials pallet description

295b816

Update comments in pallet

36ca6a2

Update description of the reclaim_deposit extrinsic

88a3aaf

More comments

98a4531

Add case for invalid input

5144705

remove unused variable in benchmarks

d054cb1

Merge branch origin/develop into aa/public-credentials-v2

4acf61c

Make comment a doc comment

7fe38a0

ntn-x2 mentioned this pull request Aug 12, 2022

feat: api augmentation for RPC and state_calls KILTprotocol/sdk-js#590

Closed

3 tasks

fmt

175ed43

weichweich suggested changes Aug 30, 2022

View reviewed changes

ntn-x2 added 9 commits September 19, 2022 09:55

Fix match case

6e54dd9

Fix import

29f5a4c

Fix single match case

9ebcd05

Fix new line

2508c30

Fix access control file

88b034c

Fix more matches

bc96327

Fix proxy type

9e43b3e

Fmt

4a310fb

Merge commit 'a7b2c43a7c02b4d3a51f895655c37e2a78412abd' into aa/publi…

69fa1c0

…c-credentials-v2

ntn-x2 requested review from weichweich and wischli September 19, 2022 14:14

wischli approved these changes Sep 20, 2022

View reviewed changes

weichweich approved these changes Sep 20, 2022

View reviewed changes

Fix repo links

3b1ab07

ntn-x2 merged commit 3290887 into develop Sep 20, 2022

ntn-x2 deleted the aa/public-credentials-v2 branch September 20, 2022 13:21

wischli added this to the 1.8.0 milestone Oct 5, 2022

ntn-x2 mentioned this pull request Oct 20, 2022

chore: remove RPC for public credentials and remove Api suffix from runtime APIs #426

Merged

ntn-x2 restored the aa/public-credentials-v2 branch November 29, 2022 10:29

	repository = "https://github.com/KILTprotocol/mashnet-node"
	repository = "https://github.com/KILTprotocol/kilt-node"

	public-credentials-runtime-api = {version = "1.7.2", path = "./runtime-api"}
	public-credentials-runtime-api = {path = "./runtime-api"}

feat: asset DIDs and public credentials #378

feat: asset DIDs and public credentials #378

Uh oh!

Conversation

ntn-x2 commented Jul 8, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

fixes KILTProtocol/ticket#2029

Pallet

RPC

Uh oh!

weichweich left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

wischli left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

weichweich left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

ntn-x2 commented Jul 8, 2022 •

edited

Loading

weichweich left a comment •

edited

Loading