-
Notifications
You must be signed in to change notification settings - Fork 7
/
claims.types.ts
386 lines (304 loc) · 8.34 KB
/
claims.types.ts
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
import { utils } from 'ethers';
import {
VerifiablePresentation,
StatusList2021Entry,
} from '@ew-did-registry/credentials-interface';
import { ClaimData } from '../did-registry';
import { IMessage } from '../messaging/messaging.types';
export interface IClaimRequest extends IMessage {
token: string;
claimType: string;
claimTypeVersion: string;
registrationTypes: RegistrationTypes[];
subjectAgreement?: string;
}
export interface IClaimIssuance extends IMessage {
// issuedToken is is only provided in the case of off-chain role
issuedToken?: string;
// onChainProof is only provided in case of on-chain role
onChainProof?: string;
claimType?: string;
claimTypeVersion?: string;
acceptedBy: string;
vp?: string;
}
export interface IClaimRejection extends IMessage {
isRejected: boolean;
rejectionReason?: string;
}
export enum RegistrationTypes {
OffChain = 'RegistrationTypes::OffChain',
OnChain = 'RegistrationTypes::OnChain',
}
export enum ClaimEventType {
ISSUE_CREDENTIAL = 'issue-credential',
REJECT_CREDENTIAL = 'reject-credential',
REQUEST_CREDENTIALS = 'request-credential',
}
export interface Claim {
id: string;
requester: string;
subject: string;
claimIssuer: string[];
claimType: string;
claimTypeVersion: string;
registrationTypes: RegistrationTypes[];
token: string;
subjectAgreement?: string;
onChainProof?: string;
issuedToken?: string;
isAccepted: boolean;
acceptedBy?: string;
isRejected?: boolean;
namespace: string;
createdAt: string;
redirectUri?: string;
vp?: VerifiablePresentation;
}
export const readyToBeRegisteredOnchain = (
claim: unknown
): claim is Required<
Pick<
Claim,
| 'claimType'
| 'claimTypeVersion'
| 'subject'
| 'onChainProof'
| 'acceptedBy'
| 'subjectAgreement'
>
> => {
if (!claim) return false;
if (typeof claim !== 'object') return false;
const requiredProps = [
'claimType',
'claimTypeVersion',
'subject',
'onChainProof',
'acceptedBy',
'subjectAgreement',
];
const claimProps = Object.keys(claim);
return requiredProps.every((p) => claimProps.includes(p));
};
export const typedMsgPrefix = '1901';
export const erc712_type_hash = utils.id(
'EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)'
);
export const agreement_type_hash = utils.id(
'Agreement(address subject,bytes32 role,uint256 version)'
);
export const proof_type_hash = utils.id(
'Proof(address subject,bytes32 role,uint256 version,uint256 expiry,address issuer)'
);
export const defaultClaimExpiry = Number.MAX_SAFE_INTEGER - 1; // constraint of ethers.BigNumber
export type RequestClaim = { requester: string; message: IClaimRequest };
export type IssueClaim = { issuer: string; message: IClaimIssuance };
export type RejectClaim = { issuer: string; message: IClaimRejection };
export interface GetClaimsByRequesterOptions {
/** DID of the requestor */
did: string;
/** Indicates whether to show only accepted `Claims` */
isAccepted?: boolean;
/** Indicates what namespace `Claims` should be in */
namespace?: string;
}
export interface GetClaimsByIssuerOptions {
/** DID of the issuer */
did: string;
/** Indicates whether to show only accepted `Claims` */
isAccepted?: boolean;
/** Indicates what namespace `Claims` should be in */
namespace?: string;
}
export interface GetClaimsBySubjectOptions {
/** DID of the subject */
did: string;
/** Indicates whether to show only accepted `Claims` */
isAccepted?: boolean;
/** Indicates what namespace `Claims` should be in */
namespace?: string;
}
export interface CreateClaimRequestOptions {
/** Claim request params */
claim: {
/** Role namespace */
claimType: string;
/** Version of the role */
claimTypeVersion: number;
/** Requestor fields that role is requiring */
requestorFields?: { key: string; value: string | number }[];
};
/** DID of the subject */
subject?: string;
/** Indicates what type of claim registration you are requesting: on-chain and/or off-chain */
registrationTypes?: RegistrationTypes[];
}
export interface IssueClaimRequestOptions {
/** DID of the claim requestor */
requester: string;
/** JWT token generated by requestor during claim request */
token: string;
/** Claim id */
id: string;
/** Subject agreement signature */
subjectAgreement?: string;
/** Registration types */
registrationTypes: RegistrationTypes[];
/** Issuer fields that role is requiring */
issuerFields?: { key: string; value: string | number }[];
/** Indicates whether to publish role on-chain or not (default: false) */
publishOnChain?: boolean;
/** Indicates if credential is actual of the time of verification */
credentialStatus?: StatusList2021Entry;
}
export interface RegisterOnchainOptions {
/** Role namespace */
claimType?: string;
/** Version of the claim type */
claimTypeVersion?: string;
/** @deprecated */
token?: string;
/** Subject agreement signature */
subjectAgreement?: string;
/** On-chain proof signature */
onChainProof: string;
/** DID of the issuer */
acceptedBy: string;
/** DID of the claim subject */
subject?: string;
}
export interface RejectClaimRequestOptions {
/** Claim id */
id: string;
/** DID of the claim requestor */
requesterDID: string;
/** Reason for rejection */
rejectionReason?: string;
}
export interface DeleteClaimOptions {
/** Claim id */
id: string;
}
export interface IssueClaimOptions {
/** DID of the claim subject */
subject: string;
/** Registration types */
registrationTypes?: RegistrationTypes[];
/** Claim params */
claim: {
/** Role namespace */
claimType: string;
/** Version of the role */
claimTypeVersion: number;
/** Issuers fields that role is requiring */
issuerFields?: { key: string; value: string | number }[];
};
}
export interface PublishPublicClaimOptions {
/** @deprecated */
token?: string;
/** Registration types */
registrationTypes?: RegistrationTypes[];
/** Claim params */
claim: {
/** JWT token generated by requestor during claim request */
token?: string;
/** Role namespace */
claimType?: string;
};
}
export interface CreateSelfSignedClaimOptions {
/** Claim data */
data: ClaimData;
/** DID of the claim subject */
subject?: string;
}
export interface GetUserClaimsOptions {
/** DID of the subject */
did?: string;
}
export interface VerifyEnrolmentPrerequisitesOptions {
/** DID of the subject */
subject: string;
/** Role claim type */
role: string;
}
export interface IssueVerifiablePresentationOptions {
/** DID of the subject */
subject: string;
/** Role claim type */
namespace: string;
/** Role version */
version: string;
/** Issuers fields that role is requiring */
issuerFields?: { key: string; value: string | number }[];
/** Indicates if credential is actual of the time of verification */
credentialStatus?: StatusList2021Entry;
}
export interface ApproveRolePublishingOptions {
/** DID of the subject */
subject: string;
/** Role claim type */
role: string;
/** Role version */
version: number;
}
export interface RevokeClaimOptions {
/** Claim id */
claimId?: string;
claim?: {
/** Claim type namespace */
namespace: string;
/** Subject of the claim */
subject: string;
};
}
export interface RevokeMultipleClaimOptions {
/** Claim id */
claimIds?: string[];
claims?: {
/** Claim type namespace */
namespace: string;
/** Subject of the claim */
subject: string;
}[];
}
export interface IsClaimRevokedOptions {
/** Claim id */
claimId?: string;
claim?: {
/** Claim type namespace */
namespace: string;
/** Subject of the claim */
subject: string;
};
}
export interface ClaimRevocationDetailsOptions {
/** Claim id */
claimId?: string;
claim?: {
/** Claim type namespace */
namespace: string;
/** Subject of the claim */
subject: string;
};
}
export interface GetRevocationClaimDetailsOptions {
/** Claim id */
claimId?: string;
claim?: {
/** Claim type namespace */
namespace: string;
/** Subject of the claim */
subject: string;
};
}
export interface GetRevocationClaimDetailsResult {
namespace: string;
subject: string;
}
export interface ClaimRevocationDetailsResult {
revoker: string;
timestamp: number;
}