Skip to content
This repository was archived by the owner on Jul 6, 2022. It is now read-only.

Commit 12b53c4

Browse files
author
Victor Wiebe
committed
fix: 🐛 blacklistTM issues with comments from PR
1 parent b25f8f2 commit 12b53c4

File tree

1 file changed

+5
-10
lines changed

1 file changed

+5
-10
lines changed

src/contract_wrappers/modules/transfer_manager/blacklist_transfer_manager_wrapper.ts

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ interface UserAddressParams {
176176
* @param startTime Start date of the blacklist type
177177
* @param endTime End date of the blacklist type
178178
* @param blacklistName Name of the blacklist type
179-
* @param repeatPeriodTime Repeat period of the blacklist type (in days)
179+
* @param repeatPeriodTime Repeat period of the blacklist type (measured in days)
180180
*/
181181
interface BlacklistTypeParams extends TxParams {
182182
startTime: Date;
@@ -189,7 +189,7 @@ interface BlacklistTypeParams extends TxParams {
189189
* @param startTime Start date of the blacklist type
190190
* @param endTime End date of the blacklist type
191191
* @param blacklistName Name of the blacklist type
192-
* @param repeatPeriodTime Repeat period of the blacklist type (in days)
192+
* @param repeatPeriodTime Repeat period of the blacklist type (measured in days)
193193
* @param investor Address of the investor
194194
*/
195195
interface AddNewInvestorToNewBlacklistParams extends BlacklistTypeParams {
@@ -200,7 +200,7 @@ interface AddNewInvestorToNewBlacklistParams extends BlacklistTypeParams {
200200
* @param startTimes Start dates of the blacklist types
201201
* @param endTimes End dates of the blacklist types
202202
* @param blacklistNames Names of the blacklist types
203-
* @param repeatPeriodTimes Repeat periods of the blacklist type (in days)
203+
* @param repeatPeriodTimes Repeat periods of the blacklist type (measured in days)
204204
*/
205205
interface BlacklistTypeMultiParams extends TxParams {
206206
startTimes: Date[];
@@ -210,23 +210,20 @@ interface BlacklistTypeMultiParams extends TxParams {
210210
}
211211

212212
/**
213-
* Used to delete the blacklist type
214213
* @param blacklistName Name of the blacklist type
215214
*/
216215
interface DeleteBlacklistTypeParams extends TxParams {
217216
blacklistName: string;
218217
}
219218

220219
/**
221-
* Used to delete the multiple blacklist types
222220
* @param blacklistNames Names of the blacklist types
223221
*/
224222
interface DeleteBlacklistTypeMultiParams extends TxParams {
225223
blacklistNames: string[];
226224
}
227225

228226
/**
229-
* Used to assign the blacklist type to the investor
230227
* @param investor Address of the investor
231228
* @param blacklistName Name of the blacklist
232229
*/
@@ -236,7 +233,6 @@ interface InvestorAndBlacklistParams extends TxParams {
236233
}
237234

238235
/**
239-
* Used to delete the investor from all the associated blacklist types
240236
* @param investor Address of the investor
241237
*/
242238
interface DeleteInvestorFromAllBlacklistParams extends TxParams {
@@ -251,7 +247,6 @@ interface DeleteInvestorFromAllBlacklistMultiParams extends TxParams {
251247
}
252248

253249
/**
254-
* Used to assign a single blacklist type to multiple investors
255250
* @param investors Address of the investor
256251
* @param blacklistName Name of the blacklist
257252
*/
@@ -283,7 +278,7 @@ interface VerifyTransfer {
283278
/**
284279
* @param startTime Date of start for blacklist
285280
* @param endTime Date of end for blacklist
286-
* @param repeatPeriodTime Days until it is repeated (0 if it is not repeated)
281+
* @param repeatPeriodTime Time until it is repeated (Measured in days) (0 if it is not repeated)
287282
*/
288283
interface BlacklistsDetails {
289284
startTime: Date;
@@ -340,7 +335,7 @@ export default class BlacklistTransferManagerWrapper extends ModuleWrapper {
340335
* Return the different blacklist details corresponding to a blacklists name
341336
*/
342337
public blacklists = async (params: BlacklistParams): Promise<BlacklistsDetails> => {
343-
assert.assert(params.blacklistName.length > 0, 'Blacklist Details must not be an empty string');
338+
assert.assert(params.blacklistName.length > 0, 'Blacklist name must not be an empty string');
344339
const result = await (await this.contract).blacklists.callAsync(stringToBytes32(params.blacklistName));
345340
return {
346341
startTime: bigNumberToDate(result[0]),

0 commit comments

Comments
 (0)