generated from PolymeshAssociation/typescript-boilerplate
-
Notifications
You must be signed in to change notification settings - Fork 11
/
Authorizations.ts
212 lines (187 loc) · 6.4 KB
/
Authorizations.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
import { PolymeshPrimitivesAuthorization } from '@polkadot/types/lookup';
import BigNumber from 'bignumber.js';
import { Account, AuthorizationRequest, Identity, Namespace, PolymeshError } from '~/internal';
import { AuthorizationArgs, authorizationsQuery } from '~/middleware/queries';
import {
Authorization as MiddlewareAuthorization,
AuthorizationStatusEnum,
AuthTypeEnum,
Query,
} from '~/middleware/types';
import { AuthorizationType, ErrorCode, ResultSet, Signer, SignerType, SignerValue } from '~/types';
import { Ensured, QueryArgs } from '~/types/utils';
import {
addressToKey,
authorizationDataToAuthorization,
authorizationTypeToMeshAuthorizationType,
bigNumberToU64,
booleanToBool,
identityIdToString,
keyToAddress,
middlewareAuthorizationDataToAuthorization,
momentToDate,
signerToSignerValue,
signerValueToSignatory,
signerValueToSigner,
u64ToBigNumber,
} from '~/utils/conversion';
import { calculateNextKey } from '~/utils/internal';
/**
* Handles all Authorization related functionality
*/
export class Authorizations<Parent extends Signer> extends Namespace<Parent> {
/**
* Fetch all pending Authorization Requests for which this Signer is the target
*
* @param opts.type - fetch only authorizations of this type. Fetches all types if not passed
* @param opts.includeExpired - whether to include expired authorizations. Defaults to true
*/
public async getReceived(opts?: {
type?: AuthorizationType;
includeExpired?: boolean;
}): Promise<AuthorizationRequest[]> {
const {
context,
parent,
context: {
polymeshApi: { rpc },
},
} = this;
const signerValue = signerToSignerValue(parent);
const signatory = signerValueToSignatory(signerValue, context);
const rawBoolean = booleanToBool(opts?.includeExpired ?? true, context);
let result: PolymeshPrimitivesAuthorization[];
if (opts?.type) {
result = await rpc.identity.getFilteredAuthorizations(
signatory,
rawBoolean,
authorizationTypeToMeshAuthorizationType(opts.type, context)
);
} else {
result = await rpc.identity.getFilteredAuthorizations(signatory, rawBoolean);
}
return this.createAuthorizationRequests(result.map(auth => ({ auth, target: signerValue })));
}
/**
* Retrieve a single Authorization Request targeting this Signer by its ID
*
* @throws if there is no Authorization Request with the passed ID targeting this Signer
*/
public async getOne(args: { id: BigNumber }): Promise<AuthorizationRequest> {
const {
context,
parent,
context: {
polymeshApi: { query },
},
} = this;
const { id } = args;
const signerValue = signerToSignerValue(parent);
const signatory = signerValueToSignatory(signerValue, context);
const rawId = bigNumberToU64(id, context);
const auth = await query.identity.authorizations(signatory, rawId);
if (auth.isNone) {
throw new PolymeshError({
code: ErrorCode.DataUnavailable,
message: 'The Authorization Request does not exist',
});
}
return this.createAuthorizationRequests([{ auth: auth.unwrap(), target: signerValue }])[0];
}
/**
* @hidden
*
* Create an array of AuthorizationRequests from an array of on-chain Authorizations
*/
protected createAuthorizationRequests(
auths: { auth: PolymeshPrimitivesAuthorization; target: SignerValue }[]
): AuthorizationRequest[] {
const { context } = this;
return auths
.map(auth => {
const {
auth: { expiry, authId, authorizationData: data, authorizedBy: issuer },
target: rawTarget,
} = auth;
const target = signerValueToSigner(rawTarget, context);
return {
authId: u64ToBigNumber(authId),
expiry: expiry.isSome ? momentToDate(expiry.unwrap()) : null,
data: authorizationDataToAuthorization(data, context),
target,
issuer: new Identity({ did: identityIdToString(issuer) }, context),
};
})
.filter(({ expiry }) => expiry === null || expiry > new Date())
.map(args => {
return new AuthorizationRequest(args, context);
});
}
/**
* Fetch all historical Authorization Requests for which this Signer is the target
*
* @param opts.type - fetch only authorizations of this type. Fetches all types if not passed
* @param opts.status - fetch only authorizations with this status. Fetches all statuses if not passed
* @param opts.size - page size
* @param opts.start - page offset
*
* @note supports pagination
* @note uses the middlewareV2
*/
public async getHistoricalAuthorizations(
opts: {
status?: AuthorizationStatusEnum;
type?: AuthTypeEnum;
size?: BigNumber;
start?: BigNumber;
} = {}
): Promise<ResultSet<AuthorizationRequest>> {
const { context, parent } = this;
const signerValue = signerToSignerValue(parent);
const { status, type, start, size } = opts;
const filters: QueryArgs<MiddlewareAuthorization, AuthorizationArgs> = { type, status };
if (signerValue.type === SignerType.Identity) {
filters.toId = signerValue.value;
} else {
filters.toKey = addressToKey(signerValue.value, context);
}
const {
data: {
authorizations: { totalCount, nodes: authorizationResult },
},
} = await context.queryMiddleware<Ensured<Query, 'authorizations'>>(
authorizationsQuery(filters, size, start)
);
const data = authorizationResult.map(middlewareAuthorization => {
const {
id,
type: authType,
data: authData,
fromId,
toId,
toKey,
expiry,
} = middlewareAuthorization;
return new AuthorizationRequest(
{
authId: new BigNumber(id),
expiry: expiry ? new Date(expiry) : null,
data: middlewareAuthorizationDataToAuthorization(context, authType, authData),
target: toId
? new Identity({ did: toId }, context)
: // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
new Account({ address: keyToAddress(toKey!, context) }, context),
issuer: new Identity({ did: fromId }, context),
},
context
);
});
const count = new BigNumber(totalCount);
const next = calculateNextKey(count, data.length, start);
return {
data,
next,
count,
};
}
}