@twin.org/attestation-models 0.0.1-next.10 → 0.0.1-next.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/changelog.md +1 -1
- package/docs/reference/interfaces/IAttestationComponent.md +33 -11
- package/docs/reference/interfaces/IAttestationConnector.md +33 -11
- package/docs/reference/interfaces/IAttestationInformation.md +1 -1
- package/docs/reference/interfaces/IAttestationJwtProof.md +1 -1
- package/package.json +1 -1
package/docs/changelog.md
CHANGED
|
@@ -16,23 +16,33 @@ Attest the data and return the collated information.
|
|
|
16
16
|
|
|
17
17
|
#### Parameters
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
##### verificationMethodId
|
|
20
|
+
|
|
21
|
+
`string`
|
|
20
22
|
|
|
21
23
|
The identity verification method to use for attesting the data.
|
|
22
24
|
|
|
23
|
-
|
|
25
|
+
##### attestationObject
|
|
26
|
+
|
|
27
|
+
`IJsonLdNodeObject`
|
|
24
28
|
|
|
25
29
|
The data to attest.
|
|
26
30
|
|
|
27
|
-
|
|
31
|
+
##### namespace?
|
|
32
|
+
|
|
33
|
+
`string`
|
|
28
34
|
|
|
29
35
|
The namespace of the connector to use for the attestation, defaults to component configured namespace.
|
|
30
36
|
|
|
31
|
-
|
|
37
|
+
##### identity?
|
|
38
|
+
|
|
39
|
+
`string`
|
|
32
40
|
|
|
33
41
|
The identity to perform the attestation operation with.
|
|
34
42
|
|
|
35
|
-
|
|
43
|
+
##### nodeIdentity?
|
|
44
|
+
|
|
45
|
+
`string`
|
|
36
46
|
|
|
37
47
|
The node identity to include in the attestation.
|
|
38
48
|
|
|
@@ -52,7 +62,9 @@ Resolve and verify the attestation id.
|
|
|
52
62
|
|
|
53
63
|
#### Parameters
|
|
54
64
|
|
|
55
|
-
|
|
65
|
+
##### id
|
|
66
|
+
|
|
67
|
+
`string`
|
|
56
68
|
|
|
57
69
|
The attestation id to verify.
|
|
58
70
|
|
|
@@ -72,15 +84,21 @@ Transfer the attestation to a new holder.
|
|
|
72
84
|
|
|
73
85
|
#### Parameters
|
|
74
86
|
|
|
75
|
-
|
|
87
|
+
##### attestationId
|
|
88
|
+
|
|
89
|
+
`string`
|
|
76
90
|
|
|
77
91
|
The attestation to transfer.
|
|
78
92
|
|
|
79
|
-
|
|
93
|
+
##### holderIdentity
|
|
94
|
+
|
|
95
|
+
`string`
|
|
80
96
|
|
|
81
97
|
The identity to transfer the attestation to.
|
|
82
98
|
|
|
83
|
-
|
|
99
|
+
##### identity?
|
|
100
|
+
|
|
101
|
+
`string`
|
|
84
102
|
|
|
85
103
|
The identity to perform the attestation operation with.
|
|
86
104
|
|
|
@@ -100,11 +118,15 @@ Destroy the attestation.
|
|
|
100
118
|
|
|
101
119
|
#### Parameters
|
|
102
120
|
|
|
103
|
-
|
|
121
|
+
##### attestationId
|
|
122
|
+
|
|
123
|
+
`string`
|
|
104
124
|
|
|
105
125
|
The attestation to transfer.
|
|
106
126
|
|
|
107
|
-
|
|
127
|
+
##### identity?
|
|
128
|
+
|
|
129
|
+
`string`
|
|
108
130
|
|
|
109
131
|
The identity to perform the attestation operation with.
|
|
110
132
|
|
|
@@ -16,19 +16,27 @@ Attest the data and return the collated information.
|
|
|
16
16
|
|
|
17
17
|
#### Parameters
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
##### controller
|
|
20
|
+
|
|
21
|
+
`string`
|
|
20
22
|
|
|
21
23
|
The controller identity of the user to access the vault keys.
|
|
22
24
|
|
|
23
|
-
|
|
25
|
+
##### address
|
|
26
|
+
|
|
27
|
+
`string`
|
|
24
28
|
|
|
25
29
|
The controller address for the attestation.
|
|
26
30
|
|
|
27
|
-
|
|
31
|
+
##### verificationMethodId
|
|
32
|
+
|
|
33
|
+
`string`
|
|
28
34
|
|
|
29
35
|
The identity verification method to use for attesting the data.
|
|
30
36
|
|
|
31
|
-
|
|
37
|
+
##### attestationObject
|
|
38
|
+
|
|
39
|
+
`IJsonLdNodeObject`
|
|
32
40
|
|
|
33
41
|
The data to attest.
|
|
34
42
|
|
|
@@ -48,7 +56,9 @@ Resolve and verify the attestation id.
|
|
|
48
56
|
|
|
49
57
|
#### Parameters
|
|
50
58
|
|
|
51
|
-
|
|
59
|
+
##### id
|
|
60
|
+
|
|
61
|
+
`string`
|
|
52
62
|
|
|
53
63
|
The attestation id to verify.
|
|
54
64
|
|
|
@@ -68,19 +78,27 @@ Transfer the attestation to a new holder.
|
|
|
68
78
|
|
|
69
79
|
#### Parameters
|
|
70
80
|
|
|
71
|
-
|
|
81
|
+
##### controller
|
|
82
|
+
|
|
83
|
+
`string`
|
|
72
84
|
|
|
73
85
|
The controller identity of the user to access the vault keys.
|
|
74
86
|
|
|
75
|
-
|
|
87
|
+
##### attestationId
|
|
88
|
+
|
|
89
|
+
`string`
|
|
76
90
|
|
|
77
91
|
The attestation to transfer.
|
|
78
92
|
|
|
79
|
-
|
|
93
|
+
##### holderIdentity
|
|
94
|
+
|
|
95
|
+
`string`
|
|
80
96
|
|
|
81
97
|
The holder identity of the attestation.
|
|
82
98
|
|
|
83
|
-
|
|
99
|
+
##### holderAddress
|
|
100
|
+
|
|
101
|
+
`string`
|
|
84
102
|
|
|
85
103
|
The new controller address of the attestation belonging to the holder.
|
|
86
104
|
|
|
@@ -100,11 +118,15 @@ Destroy the attestation.
|
|
|
100
118
|
|
|
101
119
|
#### Parameters
|
|
102
120
|
|
|
103
|
-
|
|
121
|
+
##### controller
|
|
122
|
+
|
|
123
|
+
`string`
|
|
104
124
|
|
|
105
125
|
The controller identity of the user to access the vault keys.
|
|
106
126
|
|
|
107
|
-
|
|
127
|
+
##### attestationId
|
|
128
|
+
|
|
129
|
+
`string`
|
|
108
130
|
|
|
109
131
|
The attestation to destroy.
|
|
110
132
|
|
|
@@ -6,7 +6,7 @@ Interface describing the collated attestation information.
|
|
|
6
6
|
|
|
7
7
|
### @context
|
|
8
8
|
|
|
9
|
-
> **@context**: `"https://schema.twindev.org/attestation/"` \| [`"https://schema.twindev.org/attestation/"`, `...string[]
|
|
9
|
+
> **@context**: `"https://schema.twindev.org/attestation/"` \| \[`"https://schema.twindev.org/attestation/"`, `...string[]`\]
|
|
10
10
|
|
|
11
11
|
JSON-LD Context.
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@ Interface describing an attestation proof.
|
|
|
6
6
|
|
|
7
7
|
### @context
|
|
8
8
|
|
|
9
|
-
> **@context**: `"https://schema.twindev.org/attestation/"` \| [`"https://schema.twindev.org/attestation/"`, `...string[]
|
|
9
|
+
> **@context**: `"https://schema.twindev.org/attestation/"` \| \[`"https://schema.twindev.org/attestation/"`, `...string[]`\]
|
|
10
10
|
|
|
11
11
|
JSON-LD Context.
|
|
12
12
|
|