1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

// KILT Blockchain – https://botlabs.org
// Copyright (C) 2019-2024 BOTLabs GmbH

// The KILT Blockchain is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// The KILT Blockchain is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.

// If you feel like getting in touch with us, you can do so at info@botlabs.org

#![cfg_attr(not(feature = "std"), no_std)]

use parity_scale_codec::{Codec, Decode, Encode, MaxEncodedLen};
use scale_info::TypeInfo;
use sp_std::vec::Vec;

mod did_details;
mod service_endpoint;

pub use did_details::*;
pub use service_endpoint::*;

#[derive(Encode, Decode, TypeInfo, Eq, PartialEq)]
pub struct DidLinkedInfo<
	DidIdentifier,
	AccountId,
	LinkableAccountId,
	Web3Name,
	Id,
	Type,
	Url,
	Balance,
	Key: Ord,
	BlockNumber,
> {
	pub identifier: DidIdentifier,
	pub accounts: Vec<LinkableAccountId>,
	pub w3n: Option<Web3Name>,
	pub service_endpoints: Vec<ServiceEndpoint<Id, Type, Url>>,
	pub details: DidDetails<Key, BlockNumber, AccountId, Balance>,
}

/// The DidLinkedInfo with a Web3Name represented as a byte array.
///
/// This will be returned by the runtime and processed by the client side RPC
/// implementation.
pub type RawDidLinkedInfo<DidIdentifier, AccountId, LinkableAccountId, Balance, Key, BlockNumber> = DidLinkedInfo<
	DidIdentifier,
	AccountId,
	LinkableAccountId,
	Vec<u8>,
	Vec<u8>,
	Vec<u8>,
	Vec<u8>,
	Balance,
	Key,
	BlockNumber,
>;

sp_api::decl_runtime_apis! {
	#[api_version(2)]
	pub trait Did<DidIdentifier, AccountId, LinkableAccountId, Balance, Key: Ord, BlockNumber: MaxEncodedLen> where
		DidIdentifier: Codec,
		AccountId: Codec,
		LinkableAccountId: Codec,
		BlockNumber: Codec,
		Key: Codec,
		Balance: Codec,
	{
		/// Given a web3name this returns:
		/// * the DID
		/// * public keys stored for the did
		/// * the web3name (optional)
		/// * associated accounts
		/// * service endpoints
		#[changed_in(2)]
		fn query_by_web3_name(name: Vec<u8>) -> Option<RawDidLinkedInfo<DidIdentifier, AccountId, AccountId, Balance, Key, BlockNumber>>;
		fn query_by_web3_name(name: Vec<u8>) -> Option<RawDidLinkedInfo<DidIdentifier, AccountId, LinkableAccountId, Balance, Key, BlockNumber>>;
		/// Given an account address this returns:
		/// * the DID
		/// * public keys stored for the did
		/// * the web3name (optional)
		/// * associated accounts
		/// * service endpoints
		#[changed_in(2)]
		fn query_by_account(account: AccountId) -> Option<RawDidLinkedInfo<DidIdentifier, AccountId, AccountId, Balance, Key, BlockNumber>>;
		fn query_by_account(account: LinkableAccountId) -> Option<RawDidLinkedInfo<DidIdentifier, AccountId, LinkableAccountId, Balance, Key, BlockNumber>>;
		/// Given a did this returns:
		/// * the DID
		/// * public keys stored for the did
		/// * the web3name (optional)
		/// * associated accounts
		/// * service endpoints
		#[changed_in(2)]
		fn query(did: DidIdentifier) -> Option<RawDidLinkedInfo<DidIdentifier, AccountId, AccountId, Balance, Key, BlockNumber>>;
		fn query(did: DidIdentifier) -> Option<RawDidLinkedInfo<DidIdentifier, AccountId, LinkableAccountId, Balance, Key, BlockNumber>>;
	}
}