generated from PolymeshAssociation/typescript-boilerplate
-
Notifications
You must be signed in to change notification settings - Fork 11
/
index.ts
401 lines (335 loc) · 10 KB
/
index.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
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
import { u64 } from '@polkadot/types';
import { BigNumber } from 'bignumber.js';
import { CddStatus, DidRecord } from 'polymesh-types/types';
import {
Context,
DefaultPortfolio,
Entity,
NumberedPortfolio,
PolymeshError,
SecurityToken,
TickerReservation,
Venue,
} from '~/internal';
import { tokensByTrustedClaimIssuer, tokensHeldByDid } from '~/middleware/queries';
import { Query } from '~/middleware/types';
import {
Ensured,
ErrorCode,
isCddProviderRole,
isPortfolioCustodianRole,
isTickerOwnerRole,
isTokenOwnerOrPiaRole,
isTokenOwnerRole,
isVenueOwnerRole,
Order,
ResultSet,
Role,
SubCallback,
UnsubCallback,
} from '~/types';
import {
accountIdToString,
balanceToBigNumber,
cddStatusToBoolean,
identityIdToString,
stringToIdentityId,
stringToTicker,
u64ToBigNumber,
} from '~/utils/conversion';
import { calculateNextKey, removePadding } from '~/utils/internal';
import { IdentityAuthorizations } from './IdentityAuthorizations';
import { Portfolios } from './Portfolios';
/**
* Properties that uniquely identify an Identity
*/
export interface UniqueIdentifiers {
did: string;
}
/**
* Represents an Identity in the Polymesh blockchain
*/
export class Identity extends Entity<UniqueIdentifiers> {
/**
* @hidden
* Checks if a value is of type [[UniqueIdentifiers]]
*/
public static isUniqueIdentifiers(identifier: object): identifier is UniqueIdentifiers {
const { did } = identifier as UniqueIdentifiers;
return typeof did === 'string';
}
/**
* identity ID as stored in the blockchain
*/
public did: string;
// Namespaces
public authorizations: IdentityAuthorizations;
public portfolios: Portfolios;
/**
* Create an Identity entity
*/
constructor(identifiers: UniqueIdentifiers, context: Context) {
super(identifiers, context);
const { did } = identifiers;
this.did = did;
this.authorizations = new IdentityAuthorizations(this, context);
this.portfolios = new Portfolios(this, context);
}
/**
* Check whether this Identity possesses the specified Role
*/
public async hasRole(role: Role): Promise<boolean> {
const { context, did } = this;
if (isTickerOwnerRole(role)) {
const { ticker } = role;
const reservation = new TickerReservation({ ticker }, context);
const { owner } = await reservation.details();
return owner?.did === did;
} else if (isTokenOwnerRole(role)) {
const { ticker } = role;
const token = new SecurityToken({ ticker }, context);
const { owner } = await token.details();
return owner.did === did;
} else if (isTokenOwnerOrPiaRole(role)) {
const { ticker } = role;
const token = new SecurityToken({ ticker }, context);
const { owner, primaryIssuanceAgent } = await token.details();
if (primaryIssuanceAgent) {
if (primaryIssuanceAgent.did === did) {
return true;
}
}
return owner.did === did;
} else if (isCddProviderRole(role)) {
const {
polymeshApi: {
query: { cddServiceProviders },
},
} = context;
const activeMembers = await cddServiceProviders.activeMembers();
const memberDids = activeMembers.map(identityIdToString);
return memberDids.includes(did);
} else if (isVenueOwnerRole(role)) {
const venue = new Venue({ id: role.venueId }, context);
const { owner } = await venue.details();
return owner.did === did;
} else if (isPortfolioCustodianRole(role)) {
const {
portfolioId: { did: portfolioDid, number },
} = role;
let portfolio;
if (number) {
portfolio = new NumberedPortfolio({ did: portfolioDid, id: number }, context);
} else {
portfolio = new DefaultPortfolio({ did: portfolioDid }, context);
}
return portfolio.isCustodiedBy();
}
throw new PolymeshError({
code: ErrorCode.ValidationError,
message: `Unrecognized role "${JSON.stringify(role)}"`,
});
}
/**
* Retrieve the balance of a particular Security Token
*
* @note can be subscribed to
*/
public getTokenBalance(args: { ticker: string }): Promise<BigNumber>;
public getTokenBalance(
args: { ticker: string },
callback: SubCallback<BigNumber>
): Promise<UnsubCallback>;
// eslint-disable-next-line require-jsdoc
public async getTokenBalance(
args: { ticker: string },
callback?: SubCallback<BigNumber>
): Promise<BigNumber | UnsubCallback> {
const {
did,
context,
context: {
polymeshApi: {
query: { asset },
},
},
} = this;
const { ticker } = args;
const rawTicker = stringToTicker(ticker, context);
const rawIdentityId = stringToIdentityId(did, context);
const token = await asset.tokens(rawTicker);
if (token.owner_did.isEmpty) {
throw new PolymeshError({
code: ErrorCode.FatalError,
message: `There is no Security Token with ticker "${ticker}"`,
});
}
if (callback) {
return asset.balanceOf(rawTicker, rawIdentityId, res => {
callback(balanceToBigNumber(res));
});
}
const balance = await asset.balanceOf(rawTicker, rawIdentityId);
return balanceToBigNumber(balance);
}
/**
* Check whether this Identity has a valid CDD claim
*/
public async hasValidCdd(): Promise<boolean> {
const {
context,
did,
context: {
polymeshApi: { rpc },
},
} = this;
const identityId = stringToIdentityId(did, context);
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const result: CddStatus = await (rpc as any).identity.isIdentityHasValidCdd(identityId);
return cddStatusToBoolean(result);
}
/**
* Check whether this Identity is Governance Committee member
*/
public async isGcMember(): Promise<boolean> {
const {
context: {
polymeshApi: {
query: { committeeMembership },
},
},
did,
} = this;
const activeMembers = await committeeMembership.activeMembers();
return activeMembers.map(identityIdToString).includes(did);
}
/**
* Check whether this Identity is a CDD provider
*/
public async isCddProvider(): Promise<boolean> {
const {
context: {
polymeshApi: {
query: { cddServiceProviders },
},
},
did,
} = this;
const activeMembers = await cddServiceProviders.activeMembers();
return activeMembers.map(identityIdToString).includes(did);
}
/**
* Retrieve the primary key associated with the Identity
*
* @note can be subscribed to
*/
public async getPrimaryKey(): Promise<string>;
public async getPrimaryKey(callback: SubCallback<string>): Promise<UnsubCallback>;
// eslint-disable-next-line require-jsdoc
public async getPrimaryKey(callback?: SubCallback<string>): Promise<string | UnsubCallback> {
const {
context: {
polymeshApi: {
query: { identity },
},
},
did,
context,
} = this;
const assembleResult = ({ primary_key: primaryKey }: DidRecord): string => {
return accountIdToString(primaryKey);
};
const rawDid = stringToIdentityId(did, context);
if (callback) {
return identity.didRecords(rawDid, records => callback(assembleResult(records)));
}
const didRecords = await identity.didRecords(rawDid);
return assembleResult(didRecords);
}
/**
* Retrieve a list of all tokens which were held at one point by this Identity
*
* @note supports pagination
*/
public async getHeldTokens(
opts: {
order?: Order;
size?: number;
start?: number;
} = { order: Order.Asc }
): Promise<ResultSet<SecurityToken>> {
const { context, did } = this;
const { size, start, order } = opts;
const result = await context.queryMiddleware<Ensured<Query, 'tokensHeldByDid'>>(
tokensHeldByDid({
did,
count: size,
skip: start,
order,
})
);
const {
data: {
tokensHeldByDid: { items: tokensHeldByDidList, totalCount: count },
},
} = result;
const data = tokensHeldByDidList.map(ticker => new SecurityToken({ ticker }, context));
const next = calculateNextKey(count, size, start);
return {
data,
next,
count,
};
}
/**
* Check whether this Identity possesses all specified roles
*/
public async hasRoles(roles: Role[]): Promise<boolean> {
const checkedRoles = await Promise.all(roles.map(this.hasRole.bind(this)));
return checkedRoles.every(hasRole => hasRole);
}
/**
* Get the list of tokens for which this Identity is a trusted claim issuer
*
* @note uses the middleware
*/
public async getTrustingTokens(
args: { order: Order } = { order: Order.Asc }
): Promise<SecurityToken[]> {
const { context, did } = this;
const { order } = args;
const {
data: { tokensByTrustedClaimIssuer: tickers },
} = await context.queryMiddleware<Ensured<Query, 'tokensByTrustedClaimIssuer'>>(
tokensByTrustedClaimIssuer({ claimIssuerDid: did, order })
);
return tickers.map(ticker => new SecurityToken({ ticker: removePadding(ticker) }, context));
}
/**
* Retrieve all Venues created by this Identity
*
* @note can be subscribed to
*/
public async getVenues(): Promise<Venue[]>;
public async getVenues(callback: SubCallback<Venue[]>): Promise<UnsubCallback>;
// eslint-disable-next-line require-jsdoc
public async getVenues(callback?: SubCallback<Venue[]>): Promise<Venue[] | UnsubCallback> {
const {
context: {
polymeshApi: {
query: { settlement },
},
},
did,
context,
} = this;
const assembleResult = (ids: u64[]): Venue[] =>
ids.map(id => new Venue({ id: u64ToBigNumber(id) }, context));
const rawDid = stringToIdentityId(did, context);
if (callback) {
return settlement.userVenues(rawDid, ids => callback(assembleResult(ids)));
}
const venueIds = await settlement.userVenues(rawDid);
return assembleResult(venueIds);
}
}